{"action":"created","issue":{"url":"https://api.github.com/repos/amontalenti/elements-of-python-style/issues/16","labels_url":"https://api.github.com/repos/amontalenti/elements-of-python-style/issues/16/labels{/name}","comments_url":"https://api.github.com/repos/amontalenti/elements-of-python-style/issues/16/comments","events_url":"https://api.github.com/repos/amontalenti/elements-of-python-style/issues/16/events","html_url":"https://github.com/amontalenti/elements-of-python-style/pull/16","id":124863556,"number":16,"title":"Use present imperative for docstrings","user":{"login":"jni","id":492549,"avatar_url":"https://avatars.githubusercontent.com/u/492549?v=3","gravatar_id":"","url":"https://api.github.com/users/jni","html_url":"https://github.com/jni","followers_url":"https://api.github.com/users/jni/followers","following_url":"https://api.github.com/users/jni/following{/other_user}","gists_url":"https://api.github.com/users/jni/gists{/gist_id}","starred_url":"https://api.github.com/users/jni/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jni/subscriptions","organizations_url":"https://api.github.com/users/jni/orgs","repos_url":"https://api.github.com/users/jni/repos","events_url":"https://api.github.com/users/jni/events{/privacy}","received_events_url":"https://api.github.com/users/jni/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":2,"created_at":"2016-01-04T23:36:54Z","updated_at":"2016-01-04T23:47:02Z","closed_at":null,"pull_request":{"url":"https://api.github.com/repos/amontalenti/elements-of-python-style/pulls/16","html_url":"https://github.com/amontalenti/elements-of-python-style/pull/16","diff_url":"https://github.com/amontalenti/elements-of-python-style/pull/16.diff","patch_url":"https://github.com/amontalenti/elements-of-python-style/pull/16.patch"},"body":"[PEP-257][pep257] covers docstring conventions, and has this to say on\r\nthe topic:\r\n\r\n> The docstring is a phrase ending in a period. It prescribes the\r\n> function or method's effect as a command (\"Do this\", \"Return that\"),\r\n> not as a description; e.g. don't write \"Returns the pathname ...\".\r\n\r\n[pep257]: https://www.python.org/dev/peps/pep-0257/"},"comment":{"url":"https://api.github.com/repos/amontalenti/elements-of-python-style/issues/comments/168847094","html_url":"https://github.com/amontalenti/elements-of-python-style/pull/16#issuecomment-168847094","issue_url":"https://api.github.com/repos/amontalenti/elements-of-python-style/issues/16","id":168847094,"user":{"login":"amontalenti","id":40263,"avatar_url":"https://avatars.githubusercontent.com/u/40263?v=3","gravatar_id":"","url":"https://api.github.com/users/amontalenti","html_url":"https://github.com/amontalenti","followers_url":"https://api.github.com/users/amontalenti/followers","following_url":"https://api.github.com/users/amontalenti/following{/other_user}","gists_url":"https://api.github.com/users/amontalenti/gists{/gist_id}","starred_url":"https://api.github.com/users/amontalenti/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/amontalenti/subscriptions","organizations_url":"https://api.github.com/users/amontalenti/orgs","repos_url":"https://api.github.com/users/amontalenti/repos","events_url":"https://api.github.com/users/amontalenti/events{/privacy}","received_events_url":"https://api.github.com/users/amontalenti/received_events","type":"User","site_admin":false},"created_at":"2016-01-04T23:47:02Z","updated_at":"2016-01-04T23:47:02Z","body":"@jni I agree that PEP 257 is worth a link here. Indeed, I realize I should re-read this one, it's been awhile!\r\n\r\nThanks for these contributions. Merging."}}