{"action":"created","comment":{"url":"https://api.github.com/repos/dateutil/dateutil/pulls/comments/185068246","pull_request_review_id":116386604,"id":185068246,"diff_hunk":"@@ -1459,7 +1459,8 @@ def __get_gettz():\n \n     class GettzFunc(object):\n         \"\"\"\n-        gettz takes a variety of inputs and returns a time zone.\n+        Given a variety of inputs, like time zone name and ``TZ`` varible,\n+        return a time zone.\n \n         :param object:","path":"dateutil/tz/tz.py","position":null,"original_position":8,"commit_id":"d7903ff5e84f327d67eef02be1e2bf2263b4027e","original_commit_id":"503b5e9331a4d800bb5875d02612b097c57d12de","user":{"login":"pganssle","id":1377457,"avatar_url":"https://avatars0.githubusercontent.com/u/1377457?v=4","gravatar_id":"","url":"https://api.github.com/users/pganssle","html_url":"https://github.com/pganssle","followers_url":"https://api.github.com/users/pganssle/followers","following_url":"https://api.github.com/users/pganssle/following{/other_user}","gists_url":"https://api.github.com/users/pganssle/gists{/gist_id}","starred_url":"https://api.github.com/users/pganssle/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/pganssle/subscriptions","organizations_url":"https://api.github.com/users/pganssle/orgs","repos_url":"https://api.github.com/users/pganssle/repos","events_url":"https://api.github.com/users/pganssle/events{/privacy}","received_events_url":"https://api.github.com/users/pganssle/received_events","type":"User","site_admin":false},"body":"> Do you have an example (could be anywhere) of how much detail you prefer in the docstring?\r\n\r\nI'm not really satisfied with the `dateutil` documentation in general. I personally originated the functions (and hence the docstrings) for [isoparse](https://dateutil.readthedocs.io/en/stable/parser.html#dateutil.parser.isoparse) and [default_tzinfo](https://dateutil.readthedocs.io/en/stable/utils.html#dateutil.utils.default_tzinfo), so something like that is likely what I would write, but I actually need to do a full re-organization of the documentation, and I'm not sure where information should go for each function / class.\r\n\r\nI'm thinking in the end that however it's organized, *somewhere* in the documentation, the functions and classes would be documented roughly with a `man` page level of detail.\r\n\r\n> Your explanation above was really helpful. Do you want me to make a new issue to put that information into the individual methods and functions as comments?\r\n\r\nSure.\r\n\r\n> Also, I wanted to double check:\r\n\r\n```python\r\n>>> tz.gettz() is tz.gettz\r\nFalse\r\n```\r\n> This is as designed (I think.) Because if name=None, then the time zone is not cached. Is that correct?\r\n\r\nYes and no. Ideally that would be `True` even for `None`, but since `tz.gettz()` represents local time it's made a bit more complicated by the fact that local time might change over the runtime of a program (which leads to a bunch of bugs, but we don't want to add to the bugginess by adding to the problem). As such, I'd rather err on the side of the previous non-cached behavior until we can work out how best to figure out if the \"local zone\" cache has been invalidated by changes in the execution environment.","created_at":"2018-04-30T18:25:44Z","updated_at":"2018-04-30T18:25:44Z","html_url":"https://github.com/dateutil/dateutil/pull/704#discussion_r185068246","pull_request_url":"https://api.github.com/repos/dateutil/dateutil/pulls/704","author_association":"OWNER","_links":{"self":{"href":"https://api.github.com/repos/dateutil/dateutil/pulls/comments/185068246"},"html":{"href":"https://github.com/dateutil/dateutil/pull/704#discussion_r185068246"},"pull_request":{"href":"https://api.github.com/repos/dateutil/dateutil/pulls/704"}},"in_reply_to_id":184247100},"pull_request":{"url":"https://api.github.com/repos/dateutil/dateutil/pulls/704","id":183794010,"html_url":"https://github.com/dateutil/dateutil/pull/704","diff_url":"https://github.com/dateutil/dateutil/pull/704.diff","patch_url":"https://github.com/dateutil/dateutil/pull/704.patch","issue_url":"https://api.github.com/repos/dateutil/dateutil/issues/704","number":704,"state":"open","locked":false,"title":"gettz documentation","user":{"login":"weatherpattern","id":1836118,"avatar_url":"https://avatars1.githubusercontent.com/u/1836118?v=4","gravatar_id":"","url":"https://api.github.com/users/weatherpattern","html_url":"https://github.com/weatherpattern","followers_url":"https://api.github.com/users/weatherpattern/followers","following_url":"https://api.github.com/users/weatherpattern/following{/other_user}","gists_url":"https://api.github.com/users/weatherpattern/gists{/gist_id}","starred_url":"https://api.github.com/users/weatherpattern/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/weatherpattern/subscriptions","organizations_url":"https://api.github.com/users/weatherpattern/orgs","repos_url":"https://api.github.com/users/weatherpattern/repos","events_url":"https://api.github.com/users/weatherpattern/events{/privacy}","received_events_url":"https://api.github.com/users/weatherpattern/received_events","type":"User","site_admin":false},"body":"## Summary of changes\r\nAdded parameters, return and examples to gettz.\r\n\r\nCloses #647 \r\n\r\n### Pull Request Checklist\r\n- [X] Authors have been added to [AUTHORS.md](https://github.com/dateutil/dateutil/blob/master/AUTHORS.md)\r\n- [x] News fragment added in changelog.d. See [CONTRIBUTING.md](https://github.com/dateutil/dateutil/blob/master/CONTRIBUTING.md#changelog) for details\r\n","created_at":"2018-04-24T16:27:00Z","updated_at":"2018-04-30T18:25:44Z","closed_at":null,"merged_at":null,"merge_commit_sha":"a2b56afbb0c52e66180ed282ad1b717e8c479b31","assignee":null,"assignees":[],"requested_reviewers":[],"requested_teams":[],"labels":[{"id":177049977,"url":"https://api.github.com/repos/dateutil/dateutil/labels/documentation","name":"documentation","color":"fef2c0","default":false}],"milestone":{"url":"https://api.github.com/repos/dateutil/dateutil/milestones/17","html_url":"https://github.com/dateutil/dateutil/milestone/17","labels_url":"https://api.github.com/repos/dateutil/dateutil/milestones/17/labels","id":3289459,"number":17,"title":"2.7.3","description":"Bugfix release.","creator":{"login":"pganssle","id":1377457,"avatar_url":"https://avatars0.githubusercontent.com/u/1377457?v=4","gravatar_id":"","url":"https://api.github.com/users/pganssle","html_url":"https://github.com/pganssle","followers_url":"https://api.github.com/users/pganssle/followers","following_url":"https://api.github.com/users/pganssle/following{/other_user}","gists_url":"https://api.github.com/users/pganssle/gists{/gist_id}","starred_url":"https://api.github.com/users/pganssle/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/pganssle/subscriptions","organizations_url":"https://api.github.com/users/pganssle/orgs","repos_url":"https://api.github.com/users/pganssle/repos","events_url":"https://api.github.com/users/pganssle/events{/privacy}","received_events_url":"https://api.github.com/users/pganssle/received_events","type":"User","site_admin":false},"open_issues":6,"closed_issues":13,"state":"open","created_at":"2018-04-23T12:52:39Z","updated_at":"2018-04-25T00:15:46Z","due_on":null,"closed_at":null},"commits_url":"https://api.github.com/repos/dateutil/dateutil/pulls/704/commits","review_comments_url":"https://api.github.com/repos/dateutil/dateutil/pulls/704/comments","review_comment_url":"https://api.github.com/repos/dateutil/dateutil/pulls/comments{/number}","comments_url":"https://api.github.com/repos/dateutil/dateutil/issues/704/comments","statuses_url":"https://api.github.com/repos/dateutil/dateutil/statuses/d7903ff5e84f327d67eef02be1e2bf2263b4027e","head":{"label":"weatherpattern:WIP-gettz-documentation","ref":"WIP-gettz-documentation","sha":"d7903ff5e84f327d67eef02be1e2bf2263b4027e","user":{"login":"weatherpattern","id":1836118,"avatar_url":"https://avatars1.githubusercontent.com/u/1836118?v=4","gravatar_id":"","url":"https://api.github.com/users/weatherpattern","html_url":"https://github.com/weatherpattern","followers_url":"https://api.github.com/users/weatherpattern/followers","following_url":"https://api.github.com/users/weatherpattern/following{/other_user}","gists_url":"https://api.github.com/users/weatherpattern/gists{/gist_id}","starred_url":"https://api.github.com/users/weatherpattern/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/weatherpattern/subscriptions","organizations_url":"https://api.github.com/users/weatherpattern/orgs","repos_url":"https://api.github.com/users/weatherpattern/repos","events_url":"https://api.github.com/users/weatherpattern/events{/privacy}","received_events_url":"https://api.github.com/users/weatherpattern/received_events","type":"User","site_admin":false},"repo":{"id":129301936,"name":"dateutil","full_name":"weatherpattern/dateutil","owner":{"login":"weatherpattern","id":1836118,"avatar_url":"https://avatars1.githubusercontent.com/u/1836118?v=4","gravatar_id":"","url":"https://api.github.com/users/weatherpattern","html_url":"https://github.com/weatherpattern","followers_url":"https://api.github.com/users/weatherpattern/followers","following_url":"https://api.github.com/users/weatherpattern/following{/other_user}","gists_url":"https://api.github.com/users/weatherpattern/gists{/gist_id}","starred_url":"https://api.github.com/users/weatherpattern/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/weatherpattern/subscriptions","organizations_url":"https://api.github.com/users/weatherpattern/orgs","repos_url":"https://api.github.com/users/weatherpattern/repos","events_url":"https://api.github.com/users/weatherpattern/events{/privacy}","received_events_url":"https://api.github.com/users/weatherpattern/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/weatherpattern/dateutil","description":"Useful extensions to the standard Python datetime features","fork":true,"url":"https://api.github.com/repos/weatherpattern/dateutil","forks_url":"https://api.github.com/repos/weatherpattern/dateutil/forks","keys_url":"https://api.github.com/repos/weatherpattern/dateutil/keys{/key_id}","collaborators_url":"https://api.github.com/repos/weatherpattern/dateutil/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/weatherpattern/dateutil/teams","hooks_url":"https://api.github.com/repos/weatherpattern/dateutil/hooks","issue_events_url":"https://api.github.com/repos/weatherpattern/dateutil/issues/events{/number}","events_url":"https://api.github.com/repos/weatherpattern/dateutil/events","assignees_url":"https://api.github.com/repos/weatherpattern/dateutil/assignees{/user}","branches_url":"https://api.github.com/repos/weatherpattern/dateutil/branches{/branch}","tags_url":"https://api.github.com/repos/weatherpattern/dateutil/tags","blobs_url":"https://api.github.com/repos/weatherpattern/dateutil/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/weatherpattern/dateutil/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/weatherpattern/dateutil/git/refs{/sha}","trees_url":"https://api.github.com/repos/weatherpattern/dateutil/git/trees{/sha}","statuses_url":"https://api.github.com/repos/weatherpattern/dateutil/statuses/{sha}","languages_url":"https://api.github.com/repos/weatherpattern/dateutil/languages","stargazers_url":"https://api.github.com/repos/weatherpattern/dateutil/stargazers","contributors_url":"https://api.github.com/repos/weatherpattern/dateutil/contributors","subscribers_url":"https://api.github.com/repos/weatherpattern/dateutil/subscribers","subscription_url":"https://api.github.com/repos/weatherpattern/dateutil/subscription","commits_url":"https://api.github.com/repos/weatherpattern/dateutil/commits{/sha}","git_commits_url":"https://api.github.com/repos/weatherpattern/dateutil/git/commits{/sha}","comments_url":"https://api.github.com/repos/weatherpattern/dateutil/comments{/number}","issue_comment_url":"https://api.github.com/repos/weatherpattern/dateutil/issues/comments{/number}","contents_url":"https://api.github.com/repos/weatherpattern/dateutil/contents/{+path}","compare_url":"https://api.github.com/repos/weatherpattern/dateutil/compare/{base}...{head}","merges_url":"https://api.github.com/repos/weatherpattern/dateutil/merges","archive_url":"https://api.github.com/repos/weatherpattern/dateutil/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/weatherpattern/dateutil/downloads","issues_url":"https://api.github.com/repos/weatherpattern/dateutil/issues{/number}","pulls_url":"https://api.github.com/repos/weatherpattern/dateutil/pulls{/number}","milestones_url":"https://api.github.com/repos/weatherpattern/dateutil/milestones{/number}","notifications_url":"https://api.github.com/repos/weatherpattern/dateutil/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/weatherpattern/dateutil/labels{/name}","releases_url":"https://api.github.com/repos/weatherpattern/dateutil/releases{/id}","deployments_url":"https://api.github.com/repos/weatherpattern/dateutil/deployments","created_at":"2018-04-12T19:33:04Z","updated_at":"2018-04-25T00:25:19Z","pushed_at":"2018-04-30T17:47:01Z","git_url":"git://github.com/weatherpattern/dateutil.git","ssh_url":"git@github.com:weatherpattern/dateutil.git","clone_url":"https://github.com/weatherpattern/dateutil.git","svn_url":"https://github.com/weatherpattern/dateutil","homepage":null,"size":4087,"stargazers_count":0,"watchers_count":0,"language":"Python","has_issues":false,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"archived":false,"open_issues_count":0,"license":{"key":"other","name":"Other","spdx_id":null,"url":null},"forks":0,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"dateutil:master","ref":"master","sha":"7a99868fa86d25661060c460c8bb623c2f9f0a32","user":{"login":"dateutil","id":9849410,"avatar_url":"https://avatars3.githubusercontent.com/u/9849410?v=4","gravatar_id":"","url":"https://api.github.com/users/dateutil","html_url":"https://github.com/dateutil","followers_url":"https://api.github.com/users/dateutil/followers","following_url":"https://api.github.com/users/dateutil/following{/other_user}","gists_url":"https://api.github.com/users/dateutil/gists{/gist_id}","starred_url":"https://api.github.com/users/dateutil/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dateutil/subscriptions","organizations_url":"https://api.github.com/users/dateutil/orgs","repos_url":"https://api.github.com/users/dateutil/repos","events_url":"https://api.github.com/users/dateutil/events{/privacy}","received_events_url":"https://api.github.com/users/dateutil/received_events","type":"Organization","site_admin":false},"repo":{"id":26876372,"name":"dateutil","full_name":"dateutil/dateutil","owner":{"login":"dateutil","id":9849410,"avatar_url":"https://avatars3.githubusercontent.com/u/9849410?v=4","gravatar_id":"","url":"https://api.github.com/users/dateutil","html_url":"https://github.com/dateutil","followers_url":"https://api.github.com/users/dateutil/followers","following_url":"https://api.github.com/users/dateutil/following{/other_user}","gists_url":"https://api.github.com/users/dateutil/gists{/gist_id}","starred_url":"https://api.github.com/users/dateutil/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dateutil/subscriptions","organizations_url":"https://api.github.com/users/dateutil/orgs","repos_url":"https://api.github.com/users/dateutil/repos","events_url":"https://api.github.com/users/dateutil/events{/privacy}","received_events_url":"https://api.github.com/users/dateutil/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/dateutil/dateutil","description":"Useful extensions to the standard Python datetime features","fork":false,"url":"https://api.github.com/repos/dateutil/dateutil","forks_url":"https://api.github.com/repos/dateutil/dateutil/forks","keys_url":"https://api.github.com/repos/dateutil/dateutil/keys{/key_id}","collaborators_url":"https://api.github.com/repos/dateutil/dateutil/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/dateutil/dateutil/teams","hooks_url":"https://api.github.com/repos/dateutil/dateutil/hooks","issue_events_url":"https://api.github.com/repos/dateutil/dateutil/issues/events{/number}","events_url":"https://api.github.com/repos/dateutil/dateutil/events","assignees_url":"https://api.github.com/repos/dateutil/dateutil/assignees{/user}","branches_url":"https://api.github.com/repos/dateutil/dateutil/branches{/branch}","tags_url":"https://api.github.com/repos/dateutil/dateutil/tags","blobs_url":"https://api.github.com/repos/dateutil/dateutil/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/dateutil/dateutil/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/dateutil/dateutil/git/refs{/sha}","trees_url":"https://api.github.com/repos/dateutil/dateutil/git/trees{/sha}","statuses_url":"https://api.github.com/repos/dateutil/dateutil/statuses/{sha}","languages_url":"https://api.github.com/repos/dateutil/dateutil/languages","stargazers_url":"https://api.github.com/repos/dateutil/dateutil/stargazers","contributors_url":"https://api.github.com/repos/dateutil/dateutil/contributors","subscribers_url":"https://api.github.com/repos/dateutil/dateutil/subscribers","subscription_url":"https://api.github.com/repos/dateutil/dateutil/subscription","commits_url":"https://api.github.com/repos/dateutil/dateutil/commits{/sha}","git_commits_url":"https://api.github.com/repos/dateutil/dateutil/git/commits{/sha}","comments_url":"https://api.github.com/repos/dateutil/dateutil/comments{/number}","issue_comment_url":"https://api.github.com/repos/dateutil/dateutil/issues/comments{/number}","contents_url":"https://api.github.com/repos/dateutil/dateutil/contents/{+path}","compare_url":"https://api.github.com/repos/dateutil/dateutil/compare/{base}...{head}","merges_url":"https://api.github.com/repos/dateutil/dateutil/merges","archive_url":"https://api.github.com/repos/dateutil/dateutil/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/dateutil/dateutil/downloads","issues_url":"https://api.github.com/repos/dateutil/dateutil/issues{/number}","pulls_url":"https://api.github.com/repos/dateutil/dateutil/pulls{/number}","milestones_url":"https://api.github.com/repos/dateutil/dateutil/milestones{/number}","notifications_url":"https://api.github.com/repos/dateutil/dateutil/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/dateutil/dateutil/labels{/name}","releases_url":"https://api.github.com/repos/dateutil/dateutil/releases{/id}","deployments_url":"https://api.github.com/repos/dateutil/dateutil/deployments","created_at":"2014-11-19T18:56:16Z","updated_at":"2018-04-30T17:55:25Z","pushed_at":"2018-04-30T17:47:03Z","git_url":"git://github.com/dateutil/dateutil.git","ssh_url":"git@github.com:dateutil/dateutil.git","clone_url":"https://github.com/dateutil/dateutil.git","svn_url":"https://github.com/dateutil/dateutil","homepage":null,"size":4066,"stargazers_count":659,"watchers_count":659,"language":"Python","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":197,"mirror_url":null,"archived":false,"open_issues_count":133,"license":{"key":"other","name":"Other","spdx_id":null,"url":null},"forks":197,"open_issues":133,"watchers":659,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/dateutil/dateutil/pulls/704"},"html":{"href":"https://github.com/dateutil/dateutil/pull/704"},"issue":{"href":"https://api.github.com/repos/dateutil/dateutil/issues/704"},"comments":{"href":"https://api.github.com/repos/dateutil/dateutil/issues/704/comments"},"review_comments":{"href":"https://api.github.com/repos/dateutil/dateutil/pulls/704/comments"},"review_comment":{"href":"https://api.github.com/repos/dateutil/dateutil/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/dateutil/dateutil/pulls/704/commits"},"statuses":{"href":"https://api.github.com/repos/dateutil/dateutil/statuses/d7903ff5e84f327d67eef02be1e2bf2263b4027e"}},"author_association":"NONE"}}
{"actor":{"display_login":"pganssle"}}