{"action":"created","issue":{"url":"https://api.github.com/repos/caktus/developer-documentation/issues/80","repository_url":"https://api.github.com/repos/caktus/developer-documentation","labels_url":"https://api.github.com/repos/caktus/developer-documentation/issues/80/labels{/name}","comments_url":"https://api.github.com/repos/caktus/developer-documentation/issues/80/comments","events_url":"https://api.github.com/repos/caktus/developer-documentation/issues/80/events","html_url":"https://github.com/caktus/developer-documentation/pull/80","id":365877642,"node_id":"MDExOlB1bGxSZXF1ZXN0MjE5Njg4MDgw","number":80,"title":"Remove unused JS doc-comments documentation","user":{"login":"nmashton","id":1625749,"node_id":"MDQ6VXNlcjE2MjU3NDk=","avatar_url":"https://avatars3.githubusercontent.com/u/1625749?v=4","gravatar_id":"","url":"https://api.github.com/users/nmashton","html_url":"https://github.com/nmashton","followers_url":"https://api.github.com/users/nmashton/followers","following_url":"https://api.github.com/users/nmashton/following{/other_user}","gists_url":"https://api.github.com/users/nmashton/gists{/gist_id}","starred_url":"https://api.github.com/users/nmashton/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/nmashton/subscriptions","organizations_url":"https://api.github.com/users/nmashton/orgs","repos_url":"https://api.github.com/users/nmashton/repos","events_url":"https://api.github.com/users/nmashton/events{/privacy}","received_events_url":"https://api.github.com/users/nmashton/received_events","type":"User","site_admin":false},"labels":[],"state":"closed","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":1,"created_at":"2018-10-02T12:38:31Z","updated_at":"2018-10-02T14:49:00Z","closed_at":"2018-10-02T12:58:41Z","author_association":"MEMBER","pull_request":{"url":"https://api.github.com/repos/caktus/developer-documentation/pulls/80","html_url":"https://github.com/caktus/developer-documentation/pull/80","diff_url":"https://github.com/caktus/developer-documentation/pull/80.diff","patch_url":"https://github.com/caktus/developer-documentation/pull/80.patch"},"body":"We should remove the documentation that discusses JS documentation comments. So far as I'm aware, nobody at Caktus has ever followed this practice, including myself.\r\n\r\nI still think it would be a good idea to somehow annotate our JS code with something more systematic than prose to improve its maintainability. The right way to approach this, however, would have been to establish those practices at Caktus and then document them once they achieved a steady state. Instead I made the mistake of writing a _prescriptive_ document that told people what to do, and predictably, nobody followed these guidelines."},"comment":{"url":"https://api.github.com/repos/caktus/developer-documentation/issues/comments/426302809","html_url":"https://github.com/caktus/developer-documentation/pull/80#issuecomment-426302809","issue_url":"https://api.github.com/repos/caktus/developer-documentation/issues/80","id":426302809,"node_id":"MDEyOklzc3VlQ29tbWVudDQyNjMwMjgwOQ==","user":{"login":"vkurup","id":4413,"node_id":"MDQ6VXNlcjQ0MTM=","avatar_url":"https://avatars1.githubusercontent.com/u/4413?v=4","gravatar_id":"","url":"https://api.github.com/users/vkurup","html_url":"https://github.com/vkurup","followers_url":"https://api.github.com/users/vkurup/followers","following_url":"https://api.github.com/users/vkurup/following{/other_user}","gists_url":"https://api.github.com/users/vkurup/gists{/gist_id}","starred_url":"https://api.github.com/users/vkurup/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/vkurup/subscriptions","organizations_url":"https://api.github.com/users/vkurup/orgs","repos_url":"https://api.github.com/users/vkurup/repos","events_url":"https://api.github.com/users/vkurup/events{/privacy}","received_events_url":"https://api.github.com/users/vkurup/received_events","type":"User","site_admin":false},"created_at":"2018-10-02T14:49:00Z","updated_at":"2018-10-02T14:49:00Z","author_association":"MEMBER","body":"This was actually my first time seeing these docs (at least AFAICR) and they look excellent. I think a tough problem is figuring out where docs should live so that people see them at the time they're going to be receptive to them (like at the start of a project)"}}
{"actor":{"display_login":"vkurup"}}