{"action":"created","issue":{"url":"https://api.github.com/repos/PistonDevelopers/piston/issues/1068","repository_url":"https://api.github.com/repos/PistonDevelopers/piston","labels_url":"https://api.github.com/repos/PistonDevelopers/piston/issues/1068/labels{/name}","comments_url":"https://api.github.com/repos/PistonDevelopers/piston/issues/1068/comments","events_url":"https://api.github.com/repos/PistonDevelopers/piston/issues/1068/events","html_url":"https://github.com/PistonDevelopers/piston/pull/1068","id":156642029,"number":1068,"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},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":6,"created_at":"2016-05-25T01:03:29Z","updated_at":"2016-05-28T16:40:07Z","closed_at":null,"pull_request":{"url":"https://api.github.com/repos/PistonDevelopers/piston/pulls/1068","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"},"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."},"comment":{"url":"https://api.github.com/repos/PistonDevelopers/piston/issues/comments/222317549","html_url":"https://github.com/PistonDevelopers/piston/pull/1068#issuecomment-222317549","issue_url":"https://api.github.com/repos/PistonDevelopers/piston/issues/1068","id":222317549,"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},"created_at":"2016-05-28T16:40:07Z","updated_at":"2016-05-28T16:40:07Z","body":"This PR is intended exclusively for documentation, and changes that would affect primarily documentation. Anything else should be a separate PR.\r\n\r\nI could move the guides into separate PRs. That seems like a good idea. If the guides are outdated then we update them! They're useful and worth the effort. "}}
{"actor":{"display_login":"Phlosioneer"}}