{"action":"created","comment":{"url":"https://api.github.com/repos/astropy/astropy/pulls/comments/274857907","pull_request_review_id":226018183,"id":274857907,"node_id":"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDI3NDg1NzkwNw==","diff_hunk":"@@ -0,0 +1,135 @@\n+READ_DOCSTRING = \"\"\"\n+    Read the input ``table`` and return the table.  Most of\n+    the default behavior for various parameters is determined by the Reader\n+    class.\n+\n+    See also:\n+\n+    - http://docs.astropy.org/en/stable/io/ascii/","path":"astropy/io/ascii/docs.py","position":8,"original_position":8,"commit_id":"d846503fb5b183354e96c70b2ffdc3c868e5e5b5","original_commit_id":"d846503fb5b183354e96c70b2ffdc3c868e5e5b5","user":{"login":"taldcroft","id":348089,"node_id":"MDQ6VXNlcjM0ODA4OQ==","avatar_url":"https://avatars1.githubusercontent.com/u/348089?v=4","gravatar_id":"","url":"https://api.github.com/users/taldcroft","html_url":"https://github.com/taldcroft","followers_url":"https://api.github.com/users/taldcroft/followers","following_url":"https://api.github.com/users/taldcroft/following{/other_user}","gists_url":"https://api.github.com/users/taldcroft/gists{/gist_id}","starred_url":"https://api.github.com/users/taldcroft/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/taldcroft/subscriptions","organizations_url":"https://api.github.com/users/taldcroft/orgs","repos_url":"https://api.github.com/users/taldcroft/repos","events_url":"https://api.github.com/users/taldcroft/events{/privacy}","received_events_url":"https://api.github.com/users/taldcroft/received_events","type":"User","site_admin":false},"body":"I made this change, but now I remember why it was originally this way.. these links are in the doc string that you get in the console with `Table.read.help('ascii')`:\r\n```\r\n========================================\r\nTable.read(format='ascii') documentation\r\n========================================\r\n\r\nRead the input ``table`` and return the table.  Most of\r\nthe default behavior for various parameters is determined by the Reader\r\nclass.\r\n\r\nSee also:\r\n\r\n- :ref:`io-ascii`\r\n- :ref:`astropy.io.ascii_read`\r\n```\r\nThat's not good.","created_at":"2019-04-12T10:57:40Z","updated_at":"2019-04-12T10:57:40Z","html_url":"https://github.com/astropy/astropy/pull/8255#discussion_r274857907","pull_request_url":"https://api.github.com/repos/astropy/astropy/pulls/8255","author_association":"MEMBER","_links":{"self":{"href":"https://api.github.com/repos/astropy/astropy/pulls/comments/274857907"},"html":{"href":"https://github.com/astropy/astropy/pull/8255#discussion_r274857907"},"pull_request":{"href":"https://api.github.com/repos/astropy/astropy/pulls/8255"}},"in_reply_to_id":274656954},"pull_request":{"url":"https://api.github.com/repos/astropy/astropy/pulls/8255","id":237168613,"node_id":"MDExOlB1bGxSZXF1ZXN0MjM3MTY4NjEz","html_url":"https://github.com/astropy/astropy/pull/8255","diff_url":"https://github.com/astropy/astropy/pull/8255.diff","patch_url":"https://github.com/astropy/astropy/pull/8255.patch","issue_url":"https://api.github.com/repos/astropy/astropy/issues/8255","number":8255,"state":"open","locked":false,"title":"Better docs and infrastructure for unified read/write functions","user":{"login":"taldcroft","id":348089,"node_id":"MDQ6VXNlcjM0ODA4OQ==","avatar_url":"https://avatars1.githubusercontent.com/u/348089?v=4","gravatar_id":"","url":"https://api.github.com/users/taldcroft","html_url":"https://github.com/taldcroft","followers_url":"https://api.github.com/users/taldcroft/followers","following_url":"https://api.github.com/users/taldcroft/following{/other_user}","gists_url":"https://api.github.com/users/taldcroft/gists{/gist_id}","starred_url":"https://api.github.com/users/taldcroft/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/taldcroft/subscriptions","organizations_url":"https://api.github.com/users/taldcroft/orgs","repos_url":"https://api.github.com/users/taldcroft/repos","events_url":"https://api.github.com/users/taldcroft/events{/privacy}","received_events_url":"https://api.github.com/users/taldcroft/received_events","type":"User","site_admin":false},"body":"This PR is a decent-sized update to the unified I/O infrastructure, with the main driver being to make it possible to get format-specific documentation in a simple way.  This is done with (e.g.):\r\n```\r\n>>> Table.read.help('ascii.latex')\r\n>>> Table.write.help('fits')\r\n>>> CCDData.read.help('fits')\r\n>>> Table.read.help()  # Generic reader help\r\n>>> Table.read?  # Basically the same thing\r\n```\r\nThis prints output to the console via a pager (`pydoc.pager`) and includes the generic read/write interface help and format-specific docs.\r\n\r\nIn order to make the `read.help` and `write.help` methods in a clean way I ended up with some new general-purpose infrastructure for defining read and write methods as class descriptors.  Along the way I cleaned up the `io.ascii` docs to make them more consistent within this framework.  \r\n\r\nI also did cleanup of the Table registry by removing the custom-installed 'ascii' and 'csv' entry points in favor of generic mechanisms now in place.\r\n\r\nNOTE for future readers: the comments up through https://github.com/astropy/astropy/pull/8255#issuecomment-446144448 are mostly overtaken by the new code.","created_at":"2018-12-10T00:16:32Z","updated_at":"2019-04-12T10:57:40Z","closed_at":null,"merged_at":null,"merge_commit_sha":"85b2b443f05adc10af67fa097ea8675b4fe9dff2","assignee":null,"assignees":[],"requested_reviewers":[{"login":"astrofrog","id":314716,"node_id":"MDQ6VXNlcjMxNDcxNg==","avatar_url":"https://avatars2.githubusercontent.com/u/314716?v=4","gravatar_id":"","url":"https://api.github.com/users/astrofrog","html_url":"https://github.com/astrofrog","followers_url":"https://api.github.com/users/astrofrog/followers","following_url":"https://api.github.com/users/astrofrog/following{/other_user}","gists_url":"https://api.github.com/users/astrofrog/gists{/gist_id}","starred_url":"https://api.github.com/users/astrofrog/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/astrofrog/subscriptions","organizations_url":"https://api.github.com/users/astrofrog/orgs","repos_url":"https://api.github.com/users/astrofrog/repos","events_url":"https://api.github.com/users/astrofrog/events{/privacy}","received_events_url":"https://api.github.com/users/astrofrog/received_events","type":"User","site_admin":false}],"requested_teams":[],"labels":[{"id":59660572,"node_id":"MDU6TGFiZWw1OTY2MDU3Mg==","url":"https://api.github.com/repos/astropy/astropy/labels/Ready-for-final-review","name":"Ready-for-final-review","color":"0e8a16","default":false},{"id":229192,"node_id":"MDU6TGFiZWwyMjkxOTI=","url":"https://api.github.com/repos/astropy/astropy/labels/table","name":"table","color":"c7def8","default":false},{"id":57320633,"node_id":"MDU6TGFiZWw1NzMyMDYzMw==","url":"https://api.github.com/repos/astropy/astropy/labels/unified-io","name":"unified-io","color":"bfdadc","default":false}],"milestone":{"url":"https://api.github.com/repos/astropy/astropy/milestones/65","html_url":"https://github.com/astropy/astropy/milestone/65","labels_url":"https://api.github.com/repos/astropy/astropy/milestones/65/labels","id":3667043,"node_id":"MDk6TWlsZXN0b25lMzY2NzA0Mw==","number":65,"title":"v3.2","description":"","creator":{"login":"eteq","id":346587,"node_id":"MDQ6VXNlcjM0NjU4Nw==","avatar_url":"https://avatars1.githubusercontent.com/u/346587?v=4","gravatar_id":"","url":"https://api.github.com/users/eteq","html_url":"https://github.com/eteq","followers_url":"https://api.github.com/users/eteq/followers","following_url":"https://api.github.com/users/eteq/following{/other_user}","gists_url":"https://api.github.com/users/eteq/gists{/gist_id}","starred_url":"https://api.github.com/users/eteq/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/eteq/subscriptions","organizations_url":"https://api.github.com/users/eteq/orgs","repos_url":"https://api.github.com/users/eteq/repos","events_url":"https://api.github.com/users/eteq/events{/privacy}","received_events_url":"https://api.github.com/users/eteq/received_events","type":"User","site_admin":false},"open_issues":74,"closed_issues":65,"state":"open","created_at":"2018-09-18T17:36:59Z","updated_at":"2019-04-12T10:08:05Z","due_on":"2019-04-19T07:00:00Z","closed_at":null},"commits_url":"https://api.github.com/repos/astropy/astropy/pulls/8255/commits","review_comments_url":"https://api.github.com/repos/astropy/astropy/pulls/8255/comments","review_comment_url":"https://api.github.com/repos/astropy/astropy/pulls/comments{/number}","comments_url":"https://api.github.com/repos/astropy/astropy/issues/8255/comments","statuses_url":"https://api.github.com/repos/astropy/astropy/statuses/d846503fb5b183354e96c70b2ffdc3c868e5e5b5","head":{"label":"taldcroft:unified-docs","ref":"unified-docs","sha":"d846503fb5b183354e96c70b2ffdc3c868e5e5b5","user":{"login":"taldcroft","id":348089,"node_id":"MDQ6VXNlcjM0ODA4OQ==","avatar_url":"https://avatars1.githubusercontent.com/u/348089?v=4","gravatar_id":"","url":"https://api.github.com/users/taldcroft","html_url":"https://github.com/taldcroft","followers_url":"https://api.github.com/users/taldcroft/followers","following_url":"https://api.github.com/users/taldcroft/following{/other_user}","gists_url":"https://api.github.com/users/taldcroft/gists{/gist_id}","starred_url":"https://api.github.com/users/taldcroft/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/taldcroft/subscriptions","organizations_url":"https://api.github.com/users/taldcroft/orgs","repos_url":"https://api.github.com/users/taldcroft/repos","events_url":"https://api.github.com/users/taldcroft/events{/privacy}","received_events_url":"https://api.github.com/users/taldcroft/received_events","type":"User","site_admin":false},"repo":{"id":2571537,"node_id":"MDEwOlJlcG9zaXRvcnkyNTcxNTM3","name":"astropy","full_name":"taldcroft/astropy","private":false,"owner":{"login":"taldcroft","id":348089,"node_id":"MDQ6VXNlcjM0ODA4OQ==","avatar_url":"https://avatars1.githubusercontent.com/u/348089?v=4","gravatar_id":"","url":"https://api.github.com/users/taldcroft","html_url":"https://github.com/taldcroft","followers_url":"https://api.github.com/users/taldcroft/followers","following_url":"https://api.github.com/users/taldcroft/following{/other_user}","gists_url":"https://api.github.com/users/taldcroft/gists{/gist_id}","starred_url":"https://api.github.com/users/taldcroft/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/taldcroft/subscriptions","organizations_url":"https://api.github.com/users/taldcroft/orgs","repos_url":"https://api.github.com/users/taldcroft/repos","events_url":"https://api.github.com/users/taldcroft/events{/privacy}","received_events_url":"https://api.github.com/users/taldcroft/received_events","type":"User","site_admin":false},"html_url":"https://github.com/taldcroft/astropy","description":"Main AstroPy repository","fork":true,"url":"https://api.github.com/repos/taldcroft/astropy","forks_url":"https://api.github.com/repos/taldcroft/astropy/forks","keys_url":"https://api.github.com/repos/taldcroft/astropy/keys{/key_id}","collaborators_url":"https://api.github.com/repos/taldcroft/astropy/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/taldcroft/astropy/teams","hooks_url":"https://api.github.com/repos/taldcroft/astropy/hooks","issue_events_url":"https://api.github.com/repos/taldcroft/astropy/issues/events{/number}","events_url":"https://api.github.com/repos/taldcroft/astropy/events","assignees_url":"https://api.github.com/repos/taldcroft/astropy/assignees{/user}","branches_url":"https://api.github.com/repos/taldcroft/astropy/branches{/branch}","tags_url":"https://api.github.com/repos/taldcroft/astropy/tags","blobs_url":"https://api.github.com/repos/taldcroft/astropy/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/taldcroft/astropy/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/taldcroft/astropy/git/refs{/sha}","trees_url":"https://api.github.com/repos/taldcroft/astropy/git/trees{/sha}","statuses_url":"https://api.github.com/repos/taldcroft/astropy/statuses/{sha}","languages_url":"https://api.github.com/repos/taldcroft/astropy/languages","stargazers_url":"https://api.github.com/repos/taldcroft/astropy/stargazers","contributors_url":"https://api.github.com/repos/taldcroft/astropy/contributors","subscribers_url":"https://api.github.com/repos/taldcroft/astropy/subscribers","subscription_url":"https://api.github.com/repos/taldcroft/astropy/subscription","commits_url":"https://api.github.com/repos/taldcroft/astropy/commits{/sha}","git_commits_url":"https://api.github.com/repos/taldcroft/astropy/git/commits{/sha}","comments_url":"https://api.github.com/repos/taldcroft/astropy/comments{/number}","issue_comment_url":"https://api.github.com/repos/taldcroft/astropy/issues/comments{/number}","contents_url":"https://api.github.com/repos/taldcroft/astropy/contents/{+path}","compare_url":"https://api.github.com/repos/taldcroft/astropy/compare/{base}...{head}","merges_url":"https://api.github.com/repos/taldcroft/astropy/merges","archive_url":"https://api.github.com/repos/taldcroft/astropy/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/taldcroft/astropy/downloads","issues_url":"https://api.github.com/repos/taldcroft/astropy/issues{/number}","pulls_url":"https://api.github.com/repos/taldcroft/astropy/pulls{/number}","milestones_url":"https://api.github.com/repos/taldcroft/astropy/milestones{/number}","notifications_url":"https://api.github.com/repos/taldcroft/astropy/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/taldcroft/astropy/labels{/name}","releases_url":"https://api.github.com/repos/taldcroft/astropy/releases{/id}","deployments_url":"https://api.github.com/repos/taldcroft/astropy/deployments","created_at":"2011-10-13T18:44:28Z","updated_at":"2019-04-01T03:52:08Z","pushed_at":"2019-04-11T11:18:00Z","git_url":"git://github.com/taldcroft/astropy.git","ssh_url":"git@github.com:taldcroft/astropy.git","clone_url":"https://github.com/taldcroft/astropy.git","svn_url":"https://github.com/taldcroft/astropy","homepage":"astropy.org","size":70930,"stargazers_count":1,"watchers_count":1,"language":"Python","has_issues":false,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":3,"mirror_url":null,"archived":false,"disabled":false,"open_issues_count":0,"license":null,"forks":3,"open_issues":0,"watchers":1,"default_branch":"master"}},"base":{"label":"astropy:master","ref":"master","sha":"0e1d299f8f7084b8cb6286caed92e3169317027f","user":{"login":"astropy","id":847984,"node_id":"MDEyOk9yZ2FuaXphdGlvbjg0Nzk4NA==","avatar_url":"https://avatars0.githubusercontent.com/u/847984?v=4","gravatar_id":"","url":"https://api.github.com/users/astropy","html_url":"https://github.com/astropy","followers_url":"https://api.github.com/users/astropy/followers","following_url":"https://api.github.com/users/astropy/following{/other_user}","gists_url":"https://api.github.com/users/astropy/gists{/gist_id}","starred_url":"https://api.github.com/users/astropy/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/astropy/subscriptions","organizations_url":"https://api.github.com/users/astropy/orgs","repos_url":"https://api.github.com/users/astropy/repos","events_url":"https://api.github.com/users/astropy/events{/privacy}","received_events_url":"https://api.github.com/users/astropy/received_events","type":"Organization","site_admin":false},"repo":{"id":2081289,"node_id":"MDEwOlJlcG9zaXRvcnkyMDgxMjg5","name":"astropy","full_name":"astropy/astropy","private":false,"owner":{"login":"astropy","id":847984,"node_id":"MDEyOk9yZ2FuaXphdGlvbjg0Nzk4NA==","avatar_url":"https://avatars0.githubusercontent.com/u/847984?v=4","gravatar_id":"","url":"https://api.github.com/users/astropy","html_url":"https://github.com/astropy","followers_url":"https://api.github.com/users/astropy/followers","following_url":"https://api.github.com/users/astropy/following{/other_user}","gists_url":"https://api.github.com/users/astropy/gists{/gist_id}","starred_url":"https://api.github.com/users/astropy/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/astropy/subscriptions","organizations_url":"https://api.github.com/users/astropy/orgs","repos_url":"https://api.github.com/users/astropy/repos","events_url":"https://api.github.com/users/astropy/events{/privacy}","received_events_url":"https://api.github.com/users/astropy/received_events","type":"Organization","site_admin":false},"html_url":"https://github.com/astropy/astropy","description":"Repository for the Astropy core package","fork":false,"url":"https://api.github.com/repos/astropy/astropy","forks_url":"https://api.github.com/repos/astropy/astropy/forks","keys_url":"https://api.github.com/repos/astropy/astropy/keys{/key_id}","collaborators_url":"https://api.github.com/repos/astropy/astropy/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/astropy/astropy/teams","hooks_url":"https://api.github.com/repos/astropy/astropy/hooks","issue_events_url":"https://api.github.com/repos/astropy/astropy/issues/events{/number}","events_url":"https://api.github.com/repos/astropy/astropy/events","assignees_url":"https://api.github.com/repos/astropy/astropy/assignees{/user}","branches_url":"https://api.github.com/repos/astropy/astropy/branches{/branch}","tags_url":"https://api.github.com/repos/astropy/astropy/tags","blobs_url":"https://api.github.com/repos/astropy/astropy/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/astropy/astropy/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/astropy/astropy/git/refs{/sha}","trees_url":"https://api.github.com/repos/astropy/astropy/git/trees{/sha}","statuses_url":"https://api.github.com/repos/astropy/astropy/statuses/{sha}","languages_url":"https://api.github.com/repos/astropy/astropy/languages","stargazers_url":"https://api.github.com/repos/astropy/astropy/stargazers","contributors_url":"https://api.github.com/repos/astropy/astropy/contributors","subscribers_url":"https://api.github.com/repos/astropy/astropy/subscribers","subscription_url":"https://api.github.com/repos/astropy/astropy/subscription","commits_url":"https://api.github.com/repos/astropy/astropy/commits{/sha}","git_commits_url":"https://api.github.com/repos/astropy/astropy/git/commits{/sha}","comments_url":"https://api.github.com/repos/astropy/astropy/comments{/number}","issue_comment_url":"https://api.github.com/repos/astropy/astropy/issues/comments{/number}","contents_url":"https://api.github.com/repos/astropy/astropy/contents/{+path}","compare_url":"https://api.github.com/repos/astropy/astropy/compare/{base}...{head}","merges_url":"https://api.github.com/repos/astropy/astropy/merges","archive_url":"https://api.github.com/repos/astropy/astropy/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/astropy/astropy/downloads","issues_url":"https://api.github.com/repos/astropy/astropy/issues{/number}","pulls_url":"https://api.github.com/repos/astropy/astropy/pulls{/number}","milestones_url":"https://api.github.com/repos/astropy/astropy/milestones{/number}","notifications_url":"https://api.github.com/repos/astropy/astropy/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/astropy/astropy/labels{/name}","releases_url":"https://api.github.com/repos/astropy/astropy/releases{/id}","deployments_url":"https://api.github.com/repos/astropy/astropy/deployments","created_at":"2011-07-21T01:33:49Z","updated_at":"2019-04-12T10:08:24Z","pushed_at":"2019-04-12T10:08:05Z","git_url":"git://github.com/astropy/astropy.git","ssh_url":"git@github.com:astropy/astropy.git","clone_url":"https://github.com/astropy/astropy.git","svn_url":"https://github.com/astropy/astropy","homepage":"www.astropy.org","size":78455,"stargazers_count":2038,"watchers_count":2038,"language":"Python","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":1055,"mirror_url":null,"archived":false,"disabled":false,"open_issues_count":973,"license":{"key":"bsd-3-clause","name":"BSD 3-Clause \"New\" or \"Revised\" License","spdx_id":"BSD-3-Clause","url":"https://api.github.com/licenses/bsd-3-clause","node_id":"MDc6TGljZW5zZTU="},"forks":1055,"open_issues":973,"watchers":2038,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/astropy/astropy/pulls/8255"},"html":{"href":"https://github.com/astropy/astropy/pull/8255"},"issue":{"href":"https://api.github.com/repos/astropy/astropy/issues/8255"},"comments":{"href":"https://api.github.com/repos/astropy/astropy/issues/8255/comments"},"review_comments":{"href":"https://api.github.com/repos/astropy/astropy/pulls/8255/comments"},"review_comment":{"href":"https://api.github.com/repos/astropy/astropy/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/astropy/astropy/pulls/8255/commits"},"statuses":{"href":"https://api.github.com/repos/astropy/astropy/statuses/d846503fb5b183354e96c70b2ffdc3c868e5e5b5"}},"author_association":"MEMBER"}}
{"actor":{"display_login":"taldcroft"}}