{"action":"created","issue":{"url":"https://api.github.com/repos/bitcoinjs/bitcoinjs-lib/issues/272","labels_url":"https://api.github.com/repos/bitcoinjs/bitcoinjs-lib/issues/272/labels{/name}","comments_url":"https://api.github.com/repos/bitcoinjs/bitcoinjs-lib/issues/272/comments","events_url":"https://api.github.com/repos/bitcoinjs/bitcoinjs-lib/issues/272/events","html_url":"https://github.com/bitcoinjs/bitcoinjs-lib/issues/272","id":41951150,"number":272,"title":"Documentation","user":{"login":"dcousens","id":413395,"avatar_url":"https://avatars.githubusercontent.com/u/413395?v=3","gravatar_id":"","url":"https://api.github.com/users/dcousens","html_url":"https://github.com/dcousens","followers_url":"https://api.github.com/users/dcousens/followers","following_url":"https://api.github.com/users/dcousens/following{/other_user}","gists_url":"https://api.github.com/users/dcousens/gists{/gist_id}","starred_url":"https://api.github.com/users/dcousens/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dcousens/subscriptions","organizations_url":"https://api.github.com/users/dcousens/orgs","repos_url":"https://api.github.com/users/dcousens/repos","events_url":"https://api.github.com/users/dcousens/events{/privacy}","received_events_url":"https://api.github.com/users/dcousens/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/bitcoinjs/bitcoinjs-lib/labels/todo","name":"todo","color":"fbca04"}],"state":"open","locked":false,"assignee":null,"milestone":{"url":"https://api.github.com/repos/bitcoinjs/bitcoinjs-lib/milestones/8","html_url":"https://github.com/bitcoinjs/bitcoinjs-lib/milestones/2.x.y","labels_url":"https://api.github.com/repos/bitcoinjs/bitcoinjs-lib/milestones/8/labels","id":1263673,"number":8,"title":"2.x.y","description":null,"creator":{"login":"dcousens","id":413395,"avatar_url":"https://avatars.githubusercontent.com/u/413395?v=3","gravatar_id":"","url":"https://api.github.com/users/dcousens","html_url":"https://github.com/dcousens","followers_url":"https://api.github.com/users/dcousens/followers","following_url":"https://api.github.com/users/dcousens/following{/other_user}","gists_url":"https://api.github.com/users/dcousens/gists{/gist_id}","starred_url":"https://api.github.com/users/dcousens/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dcousens/subscriptions","organizations_url":"https://api.github.com/users/dcousens/orgs","repos_url":"https://api.github.com/users/dcousens/repos","events_url":"https://api.github.com/users/dcousens/events{/privacy}","received_events_url":"https://api.github.com/users/dcousens/received_events","type":"User","site_admin":false},"open_issues":4,"closed_issues":0,"state":"open","created_at":"2015-08-20T01:01:13Z","updated_at":"2015-09-08T14:52:46Z","due_on":null,"closed_at":null},"comments":13,"created_at":"2014-09-04T15:37:23Z","updated_at":"2015-09-16T13:51:44Z","closed_at":null,"body":"Just a stub issue, but we really need to start focusing on this."},"comment":{"url":"https://api.github.com/repos/bitcoinjs/bitcoinjs-lib/issues/comments/140748143","html_url":"https://github.com/bitcoinjs/bitcoinjs-lib/issues/272#issuecomment-140748143","issue_url":"https://api.github.com/repos/bitcoinjs/bitcoinjs-lib/issues/272","id":140748143,"user":{"login":"jprichardson","id":150063,"avatar_url":"https://avatars.githubusercontent.com/u/150063?v=3","gravatar_id":"","url":"https://api.github.com/users/jprichardson","html_url":"https://github.com/jprichardson","followers_url":"https://api.github.com/users/jprichardson/followers","following_url":"https://api.github.com/users/jprichardson/following{/other_user}","gists_url":"https://api.github.com/users/jprichardson/gists{/gist_id}","starred_url":"https://api.github.com/users/jprichardson/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jprichardson/subscriptions","organizations_url":"https://api.github.com/users/jprichardson/orgs","repos_url":"https://api.github.com/users/jprichardson/repos","events_url":"https://api.github.com/users/jprichardson/events{/privacy}","received_events_url":"https://api.github.com/users/jprichardson/received_events","type":"User","site_admin":false},"created_at":"2015-09-16T13:51:44Z","updated_at":"2015-09-16T13:51:44Z","body":"> something we have to keep in sync.\r\n\r\nI'm of the school of mind that that's what it takes to produce quality software, however, I don't see any reason why this couldn't be automated to some degree.\r\n\r\nI really despise inline documentation (inline with the code/ like JSDocs) as it really bloats source files. I wouldn't mind Flow comment annotations as that's at least useful and it would improve the quality of the software. I don't have any problem or issue with documenting tests though.\r\n\r\nI have some thoughts on a building a tool to automate the process of building documentation. The number one principle of the tool would be that tests serve as the ultimate source of documentation, however expecting users of the library to dig into the test files is unreasonable. The main requirement of this tool would be to have a 'standard' sort of way to layout test files. Would changing the layout/renaming test files be something that you're opposed to?"}}