{"action":"opened","number":279,"pull_request":{"url":"https://api.github.com/repos/coursera-dl/edx-dl/pulls/279","id":42658779,"html_url":"https://github.com/coursera-dl/edx-dl/pull/279","diff_url":"https://github.com/coursera-dl/edx-dl/pull/279.diff","patch_url":"https://github.com/coursera-dl/edx-dl/pull/279.patch","issue_url":"https://api.github.com/repos/coursera-dl/edx-dl/issues/279","number":279,"state":"open","locked":false,"title":"edx_dl/common: Use comments on the classes as the module docstring.","user":{"login":"rbrito","id":212145,"avatar_url":"https://avatars.githubusercontent.com/u/212145?v=3","gravatar_id":"","url":"https://api.github.com/users/rbrito","html_url":"https://github.com/rbrito","followers_url":"https://api.github.com/users/rbrito/followers","following_url":"https://api.github.com/users/rbrito/following{/other_user}","gists_url":"https://api.github.com/users/rbrito/gists{/gist_id}","starred_url":"https://api.github.com/users/rbrito/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/rbrito/subscriptions","organizations_url":"https://api.github.com/users/rbrito/orgs","repos_url":"https://api.github.com/users/rbrito/repos","events_url":"https://api.github.com/users/rbrito/events{/privacy}","received_events_url":"https://api.github.com/users/rbrito/received_events","type":"User","site_admin":false},"body":"The huge comment that we have is better if it is made part of the docstring\r\nof the module, as that is informative when using pydoc (or any other kind of\r\ndocumentation browser that one wishes to use).\r\n\r\nIn fact, I would argue that it is even going to be nice to have it become\r\n\"part of our API\" (for the lack of a better term), as I believe that it will\r\nbring us more flexibility.\r\n\r\nSigned-off-by: Rogério Brito <rbrito@ime.usp.br>","created_at":"2015-08-18T03:49:38Z","updated_at":"2015-08-18T03:49:38Z","closed_at":null,"merged_at":null,"merge_commit_sha":null,"assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/coursera-dl/edx-dl/pulls/279/commits","review_comments_url":"https://api.github.com/repos/coursera-dl/edx-dl/pulls/279/comments","review_comment_url":"https://api.github.com/repos/coursera-dl/edx-dl/pulls/comments{/number}","comments_url":"https://api.github.com/repos/coursera-dl/edx-dl/issues/279/comments","statuses_url":"https://api.github.com/repos/coursera-dl/edx-dl/statuses/e2cbad1165dcddc00b01a8ac277c1327b265dd68","head":{"label":"coursera-dl:use-comments-as-docstring","ref":"use-comments-as-docstring","sha":"e2cbad1165dcddc00b01a8ac277c1327b265dd68","user":{"login":"coursera-dl","id":5588942,"avatar_url":"https://avatars.githubusercontent.com/u/5588942?v=3","gravatar_id":"","url":"https://api.github.com/users/coursera-dl","html_url":"https://github.com/coursera-dl","followers_url":"https://api.github.com/users/coursera-dl/followers","following_url":"https://api.github.com/users/coursera-dl/following{/other_user}","gists_url":"https://api.github.com/users/coursera-dl/gists{/gist_id}","starred_url":"https://api.github.com/users/coursera-dl/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/coursera-dl/subscriptions","organizations_url":"https://api.github.com/users/coursera-dl/orgs","repos_url":"https://api.github.com/users/coursera-dl/repos","events_url":"https://api.github.com/users/coursera-dl/events{/privacy}","received_events_url":"https://api.github.com/users/coursera-dl/received_events","type":"Organization","site_admin":false},"repo":{"id":6018162,"name":"edx-dl","full_name":"coursera-dl/edx-dl","owner":{"login":"coursera-dl","id":5588942,"avatar_url":"https://avatars.githubusercontent.com/u/5588942?v=3","gravatar_id":"","url":"https://api.github.com/users/coursera-dl","html_url":"https://github.com/coursera-dl","followers_url":"https://api.github.com/users/coursera-dl/followers","following_url":"https://api.github.com/users/coursera-dl/following{/other_user}","gists_url":"https://api.github.com/users/coursera-dl/gists{/gist_id}","starred_url":"https://api.github.com/users/coursera-dl/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/coursera-dl/subscriptions","organizations_url":"https://api.github.com/users/coursera-dl/orgs","repos_url":"https://api.github.com/users/coursera-dl/repos","events_url":"https://api.github.com/users/coursera-dl/events{/privacy}","received_events_url":"https://api.github.com/users/coursera-dl/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/coursera-dl/edx-dl","description":"A simple tool to download video lectures from edx.org.","fork":false,"url":"https://api.github.com/repos/coursera-dl/edx-dl","forks_url":"https://api.github.com/repos/coursera-dl/edx-dl/forks","keys_url":"https://api.github.com/repos/coursera-dl/edx-dl/keys{/key_id}","collaborators_url":"https://api.github.com/repos/coursera-dl/edx-dl/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/coursera-dl/edx-dl/teams","hooks_url":"https://api.github.com/repos/coursera-dl/edx-dl/hooks","issue_events_url":"https://api.github.com/repos/coursera-dl/edx-dl/issues/events{/number}","events_url":"https://api.github.com/repos/coursera-dl/edx-dl/events","assignees_url":"https://api.github.com/repos/coursera-dl/edx-dl/assignees{/user}","branches_url":"https://api.github.com/repos/coursera-dl/edx-dl/branches{/branch}","tags_url":"https://api.github.com/repos/coursera-dl/edx-dl/tags","blobs_url":"https://api.github.com/repos/coursera-dl/edx-dl/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/coursera-dl/edx-dl/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/coursera-dl/edx-dl/git/refs{/sha}","trees_url":"https://api.github.com/repos/coursera-dl/edx-dl/git/trees{/sha}","statuses_url":"https://api.github.com/repos/coursera-dl/edx-dl/statuses/{sha}","languages_url":"https://api.github.com/repos/coursera-dl/edx-dl/languages","stargazers_url":"https://api.github.com/repos/coursera-dl/edx-dl/stargazers","contributors_url":"https://api.github.com/repos/coursera-dl/edx-dl/contributors","subscribers_url":"https://api.github.com/repos/coursera-dl/edx-dl/subscribers","subscription_url":"https://api.github.com/repos/coursera-dl/edx-dl/subscription","commits_url":"https://api.github.com/repos/coursera-dl/edx-dl/commits{/sha}","git_commits_url":"https://api.github.com/repos/coursera-dl/edx-dl/git/commits{/sha}","comments_url":"https://api.github.com/repos/coursera-dl/edx-dl/comments{/number}","issue_comment_url":"https://api.github.com/repos/coursera-dl/edx-dl/issues/comments{/number}","contents_url":"https://api.github.com/repos/coursera-dl/edx-dl/contents/{+path}","compare_url":"https://api.github.com/repos/coursera-dl/edx-dl/compare/{base}...{head}","merges_url":"https://api.github.com/repos/coursera-dl/edx-dl/merges","archive_url":"https://api.github.com/repos/coursera-dl/edx-dl/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/coursera-dl/edx-dl/downloads","issues_url":"https://api.github.com/repos/coursera-dl/edx-dl/issues{/number}","pulls_url":"https://api.github.com/repos/coursera-dl/edx-dl/pulls{/number}","milestones_url":"https://api.github.com/repos/coursera-dl/edx-dl/milestones{/number}","notifications_url":"https://api.github.com/repos/coursera-dl/edx-dl/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/coursera-dl/edx-dl/labels{/name}","releases_url":"https://api.github.com/repos/coursera-dl/edx-dl/releases{/id}","created_at":"2012-09-30T12:09:56Z","updated_at":"2015-08-15T14:15:07Z","pushed_at":"2015-08-18T03:48:24Z","git_url":"git://github.com/coursera-dl/edx-dl.git","ssh_url":"git@github.com:coursera-dl/edx-dl.git","clone_url":"https://github.com/coursera-dl/edx-dl.git","svn_url":"https://github.com/coursera-dl/edx-dl","homepage":"","size":25070,"stargazers_count":315,"watchers_count":315,"language":"HTML","has_issues":true,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":224,"mirror_url":null,"open_issues_count":25,"forks":224,"open_issues":25,"watchers":315,"default_branch":"master"}},"base":{"label":"coursera-dl:master","ref":"master","sha":"a54cd21ada40c76705b3453b2de5ff587f6cf893","user":{"login":"coursera-dl","id":5588942,"avatar_url":"https://avatars.githubusercontent.com/u/5588942?v=3","gravatar_id":"","url":"https://api.github.com/users/coursera-dl","html_url":"https://github.com/coursera-dl","followers_url":"https://api.github.com/users/coursera-dl/followers","following_url":"https://api.github.com/users/coursera-dl/following{/other_user}","gists_url":"https://api.github.com/users/coursera-dl/gists{/gist_id}","starred_url":"https://api.github.com/users/coursera-dl/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/coursera-dl/subscriptions","organizations_url":"https://api.github.com/users/coursera-dl/orgs","repos_url":"https://api.github.com/users/coursera-dl/repos","events_url":"https://api.github.com/users/coursera-dl/events{/privacy}","received_events_url":"https://api.github.com/users/coursera-dl/received_events","type":"Organization","site_admin":false},"repo":{"id":6018162,"name":"edx-dl","full_name":"coursera-dl/edx-dl","owner":{"login":"coursera-dl","id":5588942,"avatar_url":"https://avatars.githubusercontent.com/u/5588942?v=3","gravatar_id":"","url":"https://api.github.com/users/coursera-dl","html_url":"https://github.com/coursera-dl","followers_url":"https://api.github.com/users/coursera-dl/followers","following_url":"https://api.github.com/users/coursera-dl/following{/other_user}","gists_url":"https://api.github.com/users/coursera-dl/gists{/gist_id}","starred_url":"https://api.github.com/users/coursera-dl/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/coursera-dl/subscriptions","organizations_url":"https://api.github.com/users/coursera-dl/orgs","repos_url":"https://api.github.com/users/coursera-dl/repos","events_url":"https://api.github.com/users/coursera-dl/events{/privacy}","received_events_url":"https://api.github.com/users/coursera-dl/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/coursera-dl/edx-dl","description":"A simple tool to download video lectures from edx.org.","fork":false,"url":"https://api.github.com/repos/coursera-dl/edx-dl","forks_url":"https://api.github.com/repos/coursera-dl/edx-dl/forks","keys_url":"https://api.github.com/repos/coursera-dl/edx-dl/keys{/key_id}","collaborators_url":"https://api.github.com/repos/coursera-dl/edx-dl/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/coursera-dl/edx-dl/teams","hooks_url":"https://api.github.com/repos/coursera-dl/edx-dl/hooks","issue_events_url":"https://api.github.com/repos/coursera-dl/edx-dl/issues/events{/number}","events_url":"https://api.github.com/repos/coursera-dl/edx-dl/events","assignees_url":"https://api.github.com/repos/coursera-dl/edx-dl/assignees{/user}","branches_url":"https://api.github.com/repos/coursera-dl/edx-dl/branches{/branch}","tags_url":"https://api.github.com/repos/coursera-dl/edx-dl/tags","blobs_url":"https://api.github.com/repos/coursera-dl/edx-dl/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/coursera-dl/edx-dl/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/coursera-dl/edx-dl/git/refs{/sha}","trees_url":"https://api.github.com/repos/coursera-dl/edx-dl/git/trees{/sha}","statuses_url":"https://api.github.com/repos/coursera-dl/edx-dl/statuses/{sha}","languages_url":"https://api.github.com/repos/coursera-dl/edx-dl/languages","stargazers_url":"https://api.github.com/repos/coursera-dl/edx-dl/stargazers","contributors_url":"https://api.github.com/repos/coursera-dl/edx-dl/contributors","subscribers_url":"https://api.github.com/repos/coursera-dl/edx-dl/subscribers","subscription_url":"https://api.github.com/repos/coursera-dl/edx-dl/subscription","commits_url":"https://api.github.com/repos/coursera-dl/edx-dl/commits{/sha}","git_commits_url":"https://api.github.com/repos/coursera-dl/edx-dl/git/commits{/sha}","comments_url":"https://api.github.com/repos/coursera-dl/edx-dl/comments{/number}","issue_comment_url":"https://api.github.com/repos/coursera-dl/edx-dl/issues/comments{/number}","contents_url":"https://api.github.com/repos/coursera-dl/edx-dl/contents/{+path}","compare_url":"https://api.github.com/repos/coursera-dl/edx-dl/compare/{base}...{head}","merges_url":"https://api.github.com/repos/coursera-dl/edx-dl/merges","archive_url":"https://api.github.com/repos/coursera-dl/edx-dl/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/coursera-dl/edx-dl/downloads","issues_url":"https://api.github.com/repos/coursera-dl/edx-dl/issues{/number}","pulls_url":"https://api.github.com/repos/coursera-dl/edx-dl/pulls{/number}","milestones_url":"https://api.github.com/repos/coursera-dl/edx-dl/milestones{/number}","notifications_url":"https://api.github.com/repos/coursera-dl/edx-dl/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/coursera-dl/edx-dl/labels{/name}","releases_url":"https://api.github.com/repos/coursera-dl/edx-dl/releases{/id}","created_at":"2012-09-30T12:09:56Z","updated_at":"2015-08-15T14:15:07Z","pushed_at":"2015-08-18T03:48:24Z","git_url":"git://github.com/coursera-dl/edx-dl.git","ssh_url":"git@github.com:coursera-dl/edx-dl.git","clone_url":"https://github.com/coursera-dl/edx-dl.git","svn_url":"https://github.com/coursera-dl/edx-dl","homepage":"","size":25070,"stargazers_count":315,"watchers_count":315,"language":"HTML","has_issues":true,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":224,"mirror_url":null,"open_issues_count":25,"forks":224,"open_issues":25,"watchers":315,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/coursera-dl/edx-dl/pulls/279"},"html":{"href":"https://github.com/coursera-dl/edx-dl/pull/279"},"issue":{"href":"https://api.github.com/repos/coursera-dl/edx-dl/issues/279"},"comments":{"href":"https://api.github.com/repos/coursera-dl/edx-dl/issues/279/comments"},"review_comments":{"href":"https://api.github.com/repos/coursera-dl/edx-dl/pulls/279/comments"},"review_comment":{"href":"https://api.github.com/repos/coursera-dl/edx-dl/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/coursera-dl/edx-dl/pulls/279/commits"},"statuses":{"href":"https://api.github.com/repos/coursera-dl/edx-dl/statuses/e2cbad1165dcddc00b01a8ac277c1327b265dd68"}},"merged":false,"mergeable":null,"mergeable_state":"unknown","merged_by":null,"comments":0,"review_comments":0,"commits":1,"additions":28,"deletions":29,"changed_files":1}}