{"action":"created","comment":{"url":"https://api.github.com/repos/PistonDevelopers/piston/pulls/comments/64985421","id":64985421,"diff_hunk":"@@ -1,18 +1,32 @@\n #![deny(missing_docs)]\n #![deny(missing_copy_implementations)]\n \n-//! Window abstraction\n+//! Window storage and interfacing traits.\n+//!\n+//! The Window, AdvancedWindow, BuildFromWindowSettings traits are used by\n+//! Piston to interface with its many backends. They aren't generally useful\n+//! for the average piston user.\n+//!\n+//! The WindowSettings structure is the preferred, ideomatic way of building\n+//! new windows in Piston. ","path":"src/window/src/lib.rs","position":12,"original_position":12,"commit_id":"a63a6e333ebf8270b354ed557e1634158da5388e","original_commit_id":"a63a6e333ebf8270b354ed557e1634158da5388e","user":{"login":"bvssvni","id":1743862,"avatar_url":"https://avatars.githubusercontent.com/u/1743862?v=3","gravatar_id":"","url":"https://api.github.com/users/bvssvni","html_url":"https://github.com/bvssvni","followers_url":"https://api.github.com/users/bvssvni/followers","following_url":"https://api.github.com/users/bvssvni/following{/other_user}","gists_url":"https://api.github.com/users/bvssvni/gists{/gist_id}","starred_url":"https://api.github.com/users/bvssvni/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/bvssvni/subscriptions","organizations_url":"https://api.github.com/users/bvssvni/orgs","repos_url":"https://api.github.com/users/bvssvni/repos","events_url":"https://api.github.com/users/bvssvni/events{/privacy}","received_events_url":"https://api.github.com/users/bvssvni/received_events","type":"User","site_admin":false},"body":"\"idiomatic\"\r\n\r\nPerhaps just tell what it does, e.g.\r\n\r\n> The `WindowSettings` structure is used to build new windows.","created_at":"2016-05-28T07:41:24Z","updated_at":"2016-05-28T07:41:24Z","html_url":"https://github.com/PistonDevelopers/piston/pull/1068#discussion_r64985421","pull_request_url":"https://api.github.com/repos/PistonDevelopers/piston/pulls/1068","_links":{"self":{"href":"https://api.github.com/repos/PistonDevelopers/piston/pulls/comments/64985421"},"html":{"href":"https://github.com/PistonDevelopers/piston/pull/1068#discussion_r64985421"},"pull_request":{"href":"https://api.github.com/repos/PistonDevelopers/piston/pulls/1068"}}},"pull_request":{"url":"https://api.github.com/repos/PistonDevelopers/piston/pulls/1068","id":71316456,"html_url":"https://github.com/PistonDevelopers/piston/pull/1068","diff_url":"https://github.com/PistonDevelopers/piston/pull/1068.diff","patch_url":"https://github.com/PistonDevelopers/piston/pull/1068.patch","issue_url":"https://api.github.com/repos/PistonDevelopers/piston/issues/1068","number":1068,"state":"open","locked":false,"title":"[WIP] Improved documentation for the Window module","user":{"login":"Phlosioneer","id":4657718,"avatar_url":"https://avatars.githubusercontent.com/u/4657718?v=3","gravatar_id":"","url":"https://api.github.com/users/Phlosioneer","html_url":"https://github.com/Phlosioneer","followers_url":"https://api.github.com/users/Phlosioneer/followers","following_url":"https://api.github.com/users/Phlosioneer/following{/other_user}","gists_url":"https://api.github.com/users/Phlosioneer/gists{/gist_id}","starred_url":"https://api.github.com/users/Phlosioneer/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Phlosioneer/subscriptions","organizations_url":"https://api.github.com/users/Phlosioneer/orgs","repos_url":"https://api.github.com/users/Phlosioneer/repos","events_url":"https://api.github.com/users/Phlosioneer/events{/privacy}","received_events_url":"https://api.github.com/users/Phlosioneer/received_events","type":"User","site_admin":false},"body":"This PR is intended to be a first step on the road to #1013.\r\nStill several things to discuss before merging into piston.\r\n\r\nI've put a few TODO's where I felt the code was incomplete. I also didn't know what to write for OpenGLWindow, as I've never used it before, and I haven't seen it in piston's library code _yet_. I'm far from an expert, though.\r\n\r\nThings that still need to be added to this PR:\r\n- [ ] Examples for the window module\r\n- [x] A guide on the use of piston windows\r\n- [ ] A guide to writing a custom window backend for piston\r\n- [x] Embedding links into documentation to other parts of the documentation, where appropriate.\r\n- [x] Documentation on _common_ cross-platform quirks, if any. Most discussion about cross-platform differences should be in the documentation of the specific backend.\r\n- [ ] Test examples in guides.","created_at":"2016-05-25T01:03:29Z","updated_at":"2016-05-28T07:41:24Z","closed_at":null,"merged_at":null,"merge_commit_sha":"007ad41750e8df9b2536aa849117f69b5571a65a","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/PistonDevelopers/piston/pulls/1068/commits","review_comments_url":"https://api.github.com/repos/PistonDevelopers/piston/pulls/1068/comments","review_comment_url":"https://api.github.com/repos/PistonDevelopers/piston/pulls/comments{/number}","comments_url":"https://api.github.com/repos/PistonDevelopers/piston/issues/1068/comments","statuses_url":"https://api.github.com/repos/PistonDevelopers/piston/statuses/a63a6e333ebf8270b354ed557e1634158da5388e","head":{"label":"Phlosioneer:window-docs","ref":"window-docs","sha":"a63a6e333ebf8270b354ed557e1634158da5388e","user":{"login":"Phlosioneer","id":4657718,"avatar_url":"https://avatars.githubusercontent.com/u/4657718?v=3","gravatar_id":"","url":"https://api.github.com/users/Phlosioneer","html_url":"https://github.com/Phlosioneer","followers_url":"https://api.github.com/users/Phlosioneer/followers","following_url":"https://api.github.com/users/Phlosioneer/following{/other_user}","gists_url":"https://api.github.com/users/Phlosioneer/gists{/gist_id}","starred_url":"https://api.github.com/users/Phlosioneer/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Phlosioneer/subscriptions","organizations_url":"https://api.github.com/users/Phlosioneer/orgs","repos_url":"https://api.github.com/users/Phlosioneer/repos","events_url":"https://api.github.com/users/Phlosioneer/events{/privacy}","received_events_url":"https://api.github.com/users/Phlosioneer/received_events","type":"User","site_admin":false},"repo":{"id":59617510,"name":"piston","full_name":"Phlosioneer/piston","owner":{"login":"Phlosioneer","id":4657718,"avatar_url":"https://avatars.githubusercontent.com/u/4657718?v=3","gravatar_id":"","url":"https://api.github.com/users/Phlosioneer","html_url":"https://github.com/Phlosioneer","followers_url":"https://api.github.com/users/Phlosioneer/followers","following_url":"https://api.github.com/users/Phlosioneer/following{/other_user}","gists_url":"https://api.github.com/users/Phlosioneer/gists{/gist_id}","starred_url":"https://api.github.com/users/Phlosioneer/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Phlosioneer/subscriptions","organizations_url":"https://api.github.com/users/Phlosioneer/orgs","repos_url":"https://api.github.com/users/Phlosioneer/repos","events_url":"https://api.github.com/users/Phlosioneer/events{/privacy}","received_events_url":"https://api.github.com/users/Phlosioneer/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/Phlosioneer/piston","description":"A modular game engine written in Rust","fork":true,"url":"https://api.github.com/repos/Phlosioneer/piston","forks_url":"https://api.github.com/repos/Phlosioneer/piston/forks","keys_url":"https://api.github.com/repos/Phlosioneer/piston/keys{/key_id}","collaborators_url":"https://api.github.com/repos/Phlosioneer/piston/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/Phlosioneer/piston/teams","hooks_url":"https://api.github.com/repos/Phlosioneer/piston/hooks","issue_events_url":"https://api.github.com/repos/Phlosioneer/piston/issues/events{/number}","events_url":"https://api.github.com/repos/Phlosioneer/piston/events","assignees_url":"https://api.github.com/repos/Phlosioneer/piston/assignees{/user}","branches_url":"https://api.github.com/repos/Phlosioneer/piston/branches{/branch}","tags_url":"https://api.github.com/repos/Phlosioneer/piston/tags","blobs_url":"https://api.github.com/repos/Phlosioneer/piston/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/Phlosioneer/piston/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/Phlosioneer/piston/git/refs{/sha}","trees_url":"https://api.github.com/repos/Phlosioneer/piston/git/trees{/sha}","statuses_url":"https://api.github.com/repos/Phlosioneer/piston/statuses/{sha}","languages_url":"https://api.github.com/repos/Phlosioneer/piston/languages","stargazers_url":"https://api.github.com/repos/Phlosioneer/piston/stargazers","contributors_url":"https://api.github.com/repos/Phlosioneer/piston/contributors","subscribers_url":"https://api.github.com/repos/Phlosioneer/piston/subscribers","subscription_url":"https://api.github.com/repos/Phlosioneer/piston/subscription","commits_url":"https://api.github.com/repos/Phlosioneer/piston/commits{/sha}","git_commits_url":"https://api.github.com/repos/Phlosioneer/piston/git/commits{/sha}","comments_url":"https://api.github.com/repos/Phlosioneer/piston/comments{/number}","issue_comment_url":"https://api.github.com/repos/Phlosioneer/piston/issues/comments{/number}","contents_url":"https://api.github.com/repos/Phlosioneer/piston/contents/{+path}","compare_url":"https://api.github.com/repos/Phlosioneer/piston/compare/{base}...{head}","merges_url":"https://api.github.com/repos/Phlosioneer/piston/merges","archive_url":"https://api.github.com/repos/Phlosioneer/piston/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/Phlosioneer/piston/downloads","issues_url":"https://api.github.com/repos/Phlosioneer/piston/issues{/number}","pulls_url":"https://api.github.com/repos/Phlosioneer/piston/pulls{/number}","milestones_url":"https://api.github.com/repos/Phlosioneer/piston/milestones{/number}","notifications_url":"https://api.github.com/repos/Phlosioneer/piston/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/Phlosioneer/piston/labels{/name}","releases_url":"https://api.github.com/repos/Phlosioneer/piston/releases{/id}","deployments_url":"https://api.github.com/repos/Phlosioneer/piston/deployments","created_at":"2016-05-25T00:14:41Z","updated_at":"2016-05-25T00:14:42Z","pushed_at":"2016-05-28T03:38:05Z","git_url":"git://github.com/Phlosioneer/piston.git","ssh_url":"git@github.com:Phlosioneer/piston.git","clone_url":"https://github.com/Phlosioneer/piston.git","svn_url":"https://github.com/Phlosioneer/piston","homepage":"http://www.piston.rs","size":4009,"stargazers_count":0,"watchers_count":0,"language":"Rust","has_issues":false,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":0,"forks":0,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"PistonDevelopers:master","ref":"master","sha":"d5c69fa8ca5021ab3c5208a9eb6318c9d268fb41","user":{"login":"PistonDevelopers","id":7623406,"avatar_url":"https://avatars.githubusercontent.com/u/7623406?v=3","gravatar_id":"","url":"https://api.github.com/users/PistonDevelopers","html_url":"https://github.com/PistonDevelopers","followers_url":"https://api.github.com/users/PistonDevelopers/followers","following_url":"https://api.github.com/users/PistonDevelopers/following{/other_user}","gists_url":"https://api.github.com/users/PistonDevelopers/gists{/gist_id}","starred_url":"https://api.github.com/users/PistonDevelopers/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/PistonDevelopers/subscriptions","organizations_url":"https://api.github.com/users/PistonDevelopers/orgs","repos_url":"https://api.github.com/users/PistonDevelopers/repos","events_url":"https://api.github.com/users/PistonDevelopers/events{/privacy}","received_events_url":"https://api.github.com/users/PistonDevelopers/received_events","type":"Organization","site_admin":false},"repo":{"id":19102672,"name":"piston","full_name":"PistonDevelopers/piston","owner":{"login":"PistonDevelopers","id":7623406,"avatar_url":"https://avatars.githubusercontent.com/u/7623406?v=3","gravatar_id":"","url":"https://api.github.com/users/PistonDevelopers","html_url":"https://github.com/PistonDevelopers","followers_url":"https://api.github.com/users/PistonDevelopers/followers","following_url":"https://api.github.com/users/PistonDevelopers/following{/other_user}","gists_url":"https://api.github.com/users/PistonDevelopers/gists{/gist_id}","starred_url":"https://api.github.com/users/PistonDevelopers/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/PistonDevelopers/subscriptions","organizations_url":"https://api.github.com/users/PistonDevelopers/orgs","repos_url":"https://api.github.com/users/PistonDevelopers/repos","events_url":"https://api.github.com/users/PistonDevelopers/events{/privacy}","received_events_url":"https://api.github.com/users/PistonDevelopers/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/PistonDevelopers/piston","description":"A modular game engine written in Rust","fork":false,"url":"https://api.github.com/repos/PistonDevelopers/piston","forks_url":"https://api.github.com/repos/PistonDevelopers/piston/forks","keys_url":"https://api.github.com/repos/PistonDevelopers/piston/keys{/key_id}","collaborators_url":"https://api.github.com/repos/PistonDevelopers/piston/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/PistonDevelopers/piston/teams","hooks_url":"https://api.github.com/repos/PistonDevelopers/piston/hooks","issue_events_url":"https://api.github.com/repos/PistonDevelopers/piston/issues/events{/number}","events_url":"https://api.github.com/repos/PistonDevelopers/piston/events","assignees_url":"https://api.github.com/repos/PistonDevelopers/piston/assignees{/user}","branches_url":"https://api.github.com/repos/PistonDevelopers/piston/branches{/branch}","tags_url":"https://api.github.com/repos/PistonDevelopers/piston/tags","blobs_url":"https://api.github.com/repos/PistonDevelopers/piston/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/PistonDevelopers/piston/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/PistonDevelopers/piston/git/refs{/sha}","trees_url":"https://api.github.com/repos/PistonDevelopers/piston/git/trees{/sha}","statuses_url":"https://api.github.com/repos/PistonDevelopers/piston/statuses/{sha}","languages_url":"https://api.github.com/repos/PistonDevelopers/piston/languages","stargazers_url":"https://api.github.com/repos/PistonDevelopers/piston/stargazers","contributors_url":"https://api.github.com/repos/PistonDevelopers/piston/contributors","subscribers_url":"https://api.github.com/repos/PistonDevelopers/piston/subscribers","subscription_url":"https://api.github.com/repos/PistonDevelopers/piston/subscription","commits_url":"https://api.github.com/repos/PistonDevelopers/piston/commits{/sha}","git_commits_url":"https://api.github.com/repos/PistonDevelopers/piston/git/commits{/sha}","comments_url":"https://api.github.com/repos/PistonDevelopers/piston/comments{/number}","issue_comment_url":"https://api.github.com/repos/PistonDevelopers/piston/issues/comments{/number}","contents_url":"https://api.github.com/repos/PistonDevelopers/piston/contents/{+path}","compare_url":"https://api.github.com/repos/PistonDevelopers/piston/compare/{base}...{head}","merges_url":"https://api.github.com/repos/PistonDevelopers/piston/merges","archive_url":"https://api.github.com/repos/PistonDevelopers/piston/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/PistonDevelopers/piston/downloads","issues_url":"https://api.github.com/repos/PistonDevelopers/piston/issues{/number}","pulls_url":"https://api.github.com/repos/PistonDevelopers/piston/pulls{/number}","milestones_url":"https://api.github.com/repos/PistonDevelopers/piston/milestones{/number}","notifications_url":"https://api.github.com/repos/PistonDevelopers/piston/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/PistonDevelopers/piston/labels{/name}","releases_url":"https://api.github.com/repos/PistonDevelopers/piston/releases{/id}","deployments_url":"https://api.github.com/repos/PistonDevelopers/piston/deployments","created_at":"2014-04-24T09:18:05Z","updated_at":"2016-05-28T06:59:33Z","pushed_at":"2016-05-28T03:38:05Z","git_url":"git://github.com/PistonDevelopers/piston.git","ssh_url":"git@github.com:PistonDevelopers/piston.git","clone_url":"https://github.com/PistonDevelopers/piston.git","svn_url":"https://github.com/PistonDevelopers/piston","homepage":"http://www.piston.rs","size":4602,"stargazers_count":1285,"watchers_count":1285,"language":"Rust","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":108,"mirror_url":null,"open_issues_count":30,"forks":108,"open_issues":30,"watchers":1285,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/PistonDevelopers/piston/pulls/1068"},"html":{"href":"https://github.com/PistonDevelopers/piston/pull/1068"},"issue":{"href":"https://api.github.com/repos/PistonDevelopers/piston/issues/1068"},"comments":{"href":"https://api.github.com/repos/PistonDevelopers/piston/issues/1068/comments"},"review_comments":{"href":"https://api.github.com/repos/PistonDevelopers/piston/pulls/1068/comments"},"review_comment":{"href":"https://api.github.com/repos/PistonDevelopers/piston/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/PistonDevelopers/piston/pulls/1068/commits"},"statuses":{"href":"https://api.github.com/repos/PistonDevelopers/piston/statuses/a63a6e333ebf8270b354ed557e1634158da5388e"}}}}
{"actor":{"display_login":"bvssvni"}}