{"action":"created","issue":{"url":"https://api.github.com/repos/kbandla/dpkt/issues/204","labels_url":"https://api.github.com/repos/kbandla/dpkt/issues/204/labels{/name}","comments_url":"https://api.github.com/repos/kbandla/dpkt/issues/204/comments","events_url":"https://api.github.com/repos/kbandla/dpkt/issues/204/events","html_url":"https://github.com/kbandla/dpkt/issues/204","id":93020837,"number":204,"title":"Pick a docstrings style for the project","user":{"login":"kbandla","id":200847,"avatar_url":"https://avatars.githubusercontent.com/u/200847?v=3","gravatar_id":"","url":"https://api.github.com/users/kbandla","html_url":"https://github.com/kbandla","followers_url":"https://api.github.com/users/kbandla/followers","following_url":"https://api.github.com/users/kbandla/following{/other_user}","gists_url":"https://api.github.com/users/kbandla/gists{/gist_id}","starred_url":"https://api.github.com/users/kbandla/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/kbandla/subscriptions","organizations_url":"https://api.github.com/users/kbandla/orgs","repos_url":"https://api.github.com/users/kbandla/repos","events_url":"https://api.github.com/users/kbandla/events{/privacy}","received_events_url":"https://api.github.com/users/kbandla/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/kbandla/dpkt/labels/documentation","name":"documentation","color":"bfd4f2"}],"state":"closed","locked":false,"assignee":null,"milestone":null,"comments":3,"created_at":"2015-07-04T15:18:57Z","updated_at":"2015-07-05T23:45:02Z","closed_at":"2015-07-05T23:45:02Z","body":"dpkt needs docstrings. This might be a dependency for #20. However, It looks like there are many different docstring conventions, apart from [PEP 0257](https://www.python.org/dev/peps/pep-0257/). We should pick one style and settle with it for dpkt. \r\nAny recommendations? \r\n\r\nHere are some I found online:\r\n* [Google Python Style Guide](https://google.github.io/styleguide/pyguide.html?showone=Comments#Comments) (looks like this can be interpreted by Sphinx)\r\n* [numpy style](https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt#docstring-standard)\r\n* others?\r\n\r\nEvery time we work on a issue, we can add docstrings to the module at the same time. Hope is that eventually we will have good coverage..\r\n"},"comment":{"url":"https://api.github.com/repos/kbandla/dpkt/issues/comments/118677118","html_url":"https://github.com/kbandla/dpkt/issues/204#issuecomment-118677118","issue_url":"https://api.github.com/repos/kbandla/dpkt/issues/204","id":118677118,"user":{"login":"kbandla","id":200847,"avatar_url":"https://avatars.githubusercontent.com/u/200847?v=3","gravatar_id":"","url":"https://api.github.com/users/kbandla","html_url":"https://github.com/kbandla","followers_url":"https://api.github.com/users/kbandla/followers","following_url":"https://api.github.com/users/kbandla/following{/other_user}","gists_url":"https://api.github.com/users/kbandla/gists{/gist_id}","starred_url":"https://api.github.com/users/kbandla/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/kbandla/subscriptions","organizations_url":"https://api.github.com/users/kbandla/orgs","repos_url":"https://api.github.com/users/kbandla/repos","events_url":"https://api.github.com/users/kbandla/events{/privacy}","received_events_url":"https://api.github.com/users/kbandla/received_events","type":"User","site_admin":false},"created_at":"2015-07-05T23:45:02Z","updated_at":"2015-07-05T23:45:02Z","body":"cool, google style it is then. Will update documentation with this choice. Time to write a lot of docstrings now.."}}