{"action":"created","issue":{"url":"https://api.github.com/repos/pyca/pynacl/issues/90","labels_url":"https://api.github.com/repos/pyca/pynacl/issues/90/labels{/name}","comments_url":"https://api.github.com/repos/pyca/pynacl/issues/90/comments","events_url":"https://api.github.com/repos/pyca/pynacl/issues/90/events","html_url":"https://github.com/pyca/pynacl/issues/90","id":37811333,"number":90,"title":"use docstrings or separate .rst files for docs?","user":{"login":"warner","id":27146,"avatar_url":"https://avatars.githubusercontent.com/u/27146?v=3","gravatar_id":"","url":"https://api.github.com/users/warner","html_url":"https://github.com/warner","followers_url":"https://api.github.com/users/warner/followers","following_url":"https://api.github.com/users/warner/following{/other_user}","gists_url":"https://api.github.com/users/warner/gists{/gist_id}","starred_url":"https://api.github.com/users/warner/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/warner/subscriptions","organizations_url":"https://api.github.com/users/warner/orgs","repos_url":"https://api.github.com/users/warner/repos","events_url":"https://api.github.com/users/warner/events{/privacy}","received_events_url":"https://api.github.com/users/warner/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":{"login":"warner","id":27146,"avatar_url":"https://avatars.githubusercontent.com/u/27146?v=3","gravatar_id":"","url":"https://api.github.com/users/warner","html_url":"https://github.com/warner","followers_url":"https://api.github.com/users/warner/followers","following_url":"https://api.github.com/users/warner/following{/other_user}","gists_url":"https://api.github.com/users/warner/gists{/gist_id}","starred_url":"https://api.github.com/users/warner/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/warner/subscriptions","organizations_url":"https://api.github.com/users/warner/orgs","repos_url":"https://api.github.com/users/warner/repos","events_url":"https://api.github.com/users/warner/events{/privacy}","received_events_url":"https://api.github.com/users/warner/received_events","type":"User","site_admin":false},"milestone":{"url":"https://api.github.com/repos/pyca/pynacl/milestones/1","html_url":"https://github.com/pyca/pynacl/milestones/v0.3.0","labels_url":"https://api.github.com/repos/pyca/pynacl/milestones/1/labels","id":719531,"number":1,"title":"v0.3.0","description":"","creator":{"login":"warner","id":27146,"avatar_url":"https://avatars.githubusercontent.com/u/27146?v=3","gravatar_id":"","url":"https://api.github.com/users/warner","html_url":"https://github.com/warner","followers_url":"https://api.github.com/users/warner/followers","following_url":"https://api.github.com/users/warner/following{/other_user}","gists_url":"https://api.github.com/users/warner/gists{/gist_id}","starred_url":"https://api.github.com/users/warner/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/warner/subscriptions","organizations_url":"https://api.github.com/users/warner/orgs","repos_url":"https://api.github.com/users/warner/repos","events_url":"https://api.github.com/users/warner/events{/privacy}","received_events_url":"https://api.github.com/users/warner/received_events","type":"User","site_admin":false},"open_issues":2,"closed_issues":1,"state":"open","created_at":"2014-07-13T19:23:19Z","updated_at":"2014-07-16T18:28:57Z","due_on":"2014-07-20T07:00:00Z","closed_at":null},"comments":29,"created_at":"2014-07-14T18:10:51Z","updated_at":"2015-03-04T06:10:38Z","closed_at":null,"body":"In #73 @lvh noticed that #77 removed a bunch of docstrings, in favor of separate .rst files. Are we cool with this? I agree with @lvh that docstrings are awfully handy. (I hadn't realized that removing the \"autodoc\" code was related to removing docstrings).\r\n\r\nPersonally, I'm -0 on removing docstrings. I like having API summaries in the docstrings, and then longer-form prose/tutorial/examples in the standalone files.\r\n\r\nI'll volunteer to write docstrings if someone tells me what format I should use. Maybe they'd be easier to write/maintain if they don't need to be machine-readable?\r\n"},"comment":{"url":"https://api.github.com/repos/pyca/pynacl/issues/comments/77102488","html_url":"https://github.com/pyca/pynacl/issues/90#issuecomment-77102488","issue_url":"https://api.github.com/repos/pyca/pynacl/issues/90","id":77102488,"user":{"login":"warner","id":27146,"avatar_url":"https://avatars.githubusercontent.com/u/27146?v=3","gravatar_id":"","url":"https://api.github.com/users/warner","html_url":"https://github.com/warner","followers_url":"https://api.github.com/users/warner/followers","following_url":"https://api.github.com/users/warner/following{/other_user}","gists_url":"https://api.github.com/users/warner/gists{/gist_id}","starred_url":"https://api.github.com/users/warner/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/warner/subscriptions","organizations_url":"https://api.github.com/users/warner/orgs","repos_url":"https://api.github.com/users/warner/repos","events_url":"https://api.github.com/users/warner/events{/privacy}","received_events_url":"https://api.github.com/users/warner/received_events","type":"User","site_admin":false},"created_at":"2015-03-04T06:10:38Z","updated_at":"2015-03-04T06:10:38Z","body":"#126 restored the docstrings. Nothing left in this issue needs to be in 0.3.0, so I'm removing the milestone flag.\r\n"}}