{"action":"opened","number":4588,"pull_request":{"url":"https://api.github.com/repos/celery/celery/pulls/4588","id":174156743,"html_url":"https://github.com/celery/celery/pull/4588","diff_url":"https://github.com/celery/celery/pull/4588.diff","patch_url":"https://github.com/celery/celery/pull/4588.patch","issue_url":"https://api.github.com/repos/celery/celery/issues/4588","number":4588,"state":"open","locked":false,"title":"Teach autodoc to document tasks if undoc-members is not set","user":{"login":"lpsinger","id":728407,"avatar_url":"https://avatars2.githubusercontent.com/u/728407?v=4","gravatar_id":"","url":"https://api.github.com/users/lpsinger","html_url":"https://github.com/lpsinger","followers_url":"https://api.github.com/users/lpsinger/followers","following_url":"https://api.github.com/users/lpsinger/following{/other_user}","gists_url":"https://api.github.com/users/lpsinger/gists{/gist_id}","starred_url":"https://api.github.com/users/lpsinger/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/lpsinger/subscriptions","organizations_url":"https://api.github.com/users/lpsinger/orgs","repos_url":"https://api.github.com/users/lpsinger/repos","events_url":"https://api.github.com/users/lpsinger/events{/privacy}","received_events_url":"https://api.github.com/users/lpsinger/received_events","type":"User","site_admin":false},"body":"Celery tasks created with the @task decorator have the property that `obj.__doc__` and `obj.__class__.__doc__` are equal, which trips up the logic in `sphinx.ext.autodoc` that is supposed to suppress repetition of class documentation in an instance of the class. We have to override that behavior so that autodoc picks up tasks whether or not autodoc's `undoc-members` flag is set.\r\n\r\nBecause autodoc really works now, we also have to correctly check that the task was defined in the current module!\r\n\r\nFixes #4587.","created_at":"2018-03-10T06:33:11Z","updated_at":"2018-03-10T06:33:11Z","closed_at":null,"merged_at":null,"merge_commit_sha":null,"assignee":null,"assignees":[],"requested_reviewers":[],"requested_teams":[],"labels":[],"milestone":null,"commits_url":"https://api.github.com/repos/celery/celery/pulls/4588/commits","review_comments_url":"https://api.github.com/repos/celery/celery/pulls/4588/comments","review_comment_url":"https://api.github.com/repos/celery/celery/pulls/comments{/number}","comments_url":"https://api.github.com/repos/celery/celery/issues/4588/comments","statuses_url":"https://api.github.com/repos/celery/celery/statuses/9f0e59b3c83b51db38e8edf24b57658fe5de4dcc","head":{"label":"lpsinger:sphinx-undoc-members","ref":"sphinx-undoc-members","sha":"9f0e59b3c83b51db38e8edf24b57658fe5de4dcc","user":{"login":"lpsinger","id":728407,"avatar_url":"https://avatars2.githubusercontent.com/u/728407?v=4","gravatar_id":"","url":"https://api.github.com/users/lpsinger","html_url":"https://github.com/lpsinger","followers_url":"https://api.github.com/users/lpsinger/followers","following_url":"https://api.github.com/users/lpsinger/following{/other_user}","gists_url":"https://api.github.com/users/lpsinger/gists{/gist_id}","starred_url":"https://api.github.com/users/lpsinger/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/lpsinger/subscriptions","organizations_url":"https://api.github.com/users/lpsinger/orgs","repos_url":"https://api.github.com/users/lpsinger/repos","events_url":"https://api.github.com/users/lpsinger/events{/privacy}","received_events_url":"https://api.github.com/users/lpsinger/received_events","type":"User","site_admin":false},"repo":{"id":113229466,"name":"celery","full_name":"lpsinger/celery","owner":{"login":"lpsinger","id":728407,"avatar_url":"https://avatars2.githubusercontent.com/u/728407?v=4","gravatar_id":"","url":"https://api.github.com/users/lpsinger","html_url":"https://github.com/lpsinger","followers_url":"https://api.github.com/users/lpsinger/followers","following_url":"https://api.github.com/users/lpsinger/following{/other_user}","gists_url":"https://api.github.com/users/lpsinger/gists{/gist_id}","starred_url":"https://api.github.com/users/lpsinger/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/lpsinger/subscriptions","organizations_url":"https://api.github.com/users/lpsinger/orgs","repos_url":"https://api.github.com/users/lpsinger/repos","events_url":"https://api.github.com/users/lpsinger/events{/privacy}","received_events_url":"https://api.github.com/users/lpsinger/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/lpsinger/celery","description":"Distributed Task Queue (development branch)","fork":true,"url":"https://api.github.com/repos/lpsinger/celery","forks_url":"https://api.github.com/repos/lpsinger/celery/forks","keys_url":"https://api.github.com/repos/lpsinger/celery/keys{/key_id}","collaborators_url":"https://api.github.com/repos/lpsinger/celery/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/lpsinger/celery/teams","hooks_url":"https://api.github.com/repos/lpsinger/celery/hooks","issue_events_url":"https://api.github.com/repos/lpsinger/celery/issues/events{/number}","events_url":"https://api.github.com/repos/lpsinger/celery/events","assignees_url":"https://api.github.com/repos/lpsinger/celery/assignees{/user}","branches_url":"https://api.github.com/repos/lpsinger/celery/branches{/branch}","tags_url":"https://api.github.com/repos/lpsinger/celery/tags","blobs_url":"https://api.github.com/repos/lpsinger/celery/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/lpsinger/celery/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/lpsinger/celery/git/refs{/sha}","trees_url":"https://api.github.com/repos/lpsinger/celery/git/trees{/sha}","statuses_url":"https://api.github.com/repos/lpsinger/celery/statuses/{sha}","languages_url":"https://api.github.com/repos/lpsinger/celery/languages","stargazers_url":"https://api.github.com/repos/lpsinger/celery/stargazers","contributors_url":"https://api.github.com/repos/lpsinger/celery/contributors","subscribers_url":"https://api.github.com/repos/lpsinger/celery/subscribers","subscription_url":"https://api.github.com/repos/lpsinger/celery/subscription","commits_url":"https://api.github.com/repos/lpsinger/celery/commits{/sha}","git_commits_url":"https://api.github.com/repos/lpsinger/celery/git/commits{/sha}","comments_url":"https://api.github.com/repos/lpsinger/celery/comments{/number}","issue_comment_url":"https://api.github.com/repos/lpsinger/celery/issues/comments{/number}","contents_url":"https://api.github.com/repos/lpsinger/celery/contents/{+path}","compare_url":"https://api.github.com/repos/lpsinger/celery/compare/{base}...{head}","merges_url":"https://api.github.com/repos/lpsinger/celery/merges","archive_url":"https://api.github.com/repos/lpsinger/celery/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/lpsinger/celery/downloads","issues_url":"https://api.github.com/repos/lpsinger/celery/issues{/number}","pulls_url":"https://api.github.com/repos/lpsinger/celery/pulls{/number}","milestones_url":"https://api.github.com/repos/lpsinger/celery/milestones{/number}","notifications_url":"https://api.github.com/repos/lpsinger/celery/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/lpsinger/celery/labels{/name}","releases_url":"https://api.github.com/repos/lpsinger/celery/releases{/id}","deployments_url":"https://api.github.com/repos/lpsinger/celery/deployments","created_at":"2017-12-05T20:26:46Z","updated_at":"2017-12-05T20:26:51Z","pushed_at":"2018-03-10T06:32:34Z","git_url":"git://github.com/lpsinger/celery.git","ssh_url":"git@github.com:lpsinger/celery.git","clone_url":"https://github.com/lpsinger/celery.git","svn_url":"https://github.com/lpsinger/celery","homepage":"http://celeryproject.org","size":46541,"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":null,"forks":0,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"celery:master","ref":"master","sha":"339dba04bbbbddce4a9b6a862ae79434d6a221c1","user":{"login":"celery","id":319983,"avatar_url":"https://avatars2.githubusercontent.com/u/319983?v=4","gravatar_id":"","url":"https://api.github.com/users/celery","html_url":"https://github.com/celery","followers_url":"https://api.github.com/users/celery/followers","following_url":"https://api.github.com/users/celery/following{/other_user}","gists_url":"https://api.github.com/users/celery/gists{/gist_id}","starred_url":"https://api.github.com/users/celery/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/celery/subscriptions","organizations_url":"https://api.github.com/users/celery/orgs","repos_url":"https://api.github.com/users/celery/repos","events_url":"https://api.github.com/users/celery/events{/privacy}","received_events_url":"https://api.github.com/users/celery/received_events","type":"Organization","site_admin":false},"repo":{"id":184460,"name":"celery","full_name":"celery/celery","owner":{"login":"celery","id":319983,"avatar_url":"https://avatars2.githubusercontent.com/u/319983?v=4","gravatar_id":"","url":"https://api.github.com/users/celery","html_url":"https://github.com/celery","followers_url":"https://api.github.com/users/celery/followers","following_url":"https://api.github.com/users/celery/following{/other_user}","gists_url":"https://api.github.com/users/celery/gists{/gist_id}","starred_url":"https://api.github.com/users/celery/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/celery/subscriptions","organizations_url":"https://api.github.com/users/celery/orgs","repos_url":"https://api.github.com/users/celery/repos","events_url":"https://api.github.com/users/celery/events{/privacy}","received_events_url":"https://api.github.com/users/celery/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/celery/celery","description":"Distributed Task Queue (development branch)","fork":false,"url":"https://api.github.com/repos/celery/celery","forks_url":"https://api.github.com/repos/celery/celery/forks","keys_url":"https://api.github.com/repos/celery/celery/keys{/key_id}","collaborators_url":"https://api.github.com/repos/celery/celery/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/celery/celery/teams","hooks_url":"https://api.github.com/repos/celery/celery/hooks","issue_events_url":"https://api.github.com/repos/celery/celery/issues/events{/number}","events_url":"https://api.github.com/repos/celery/celery/events","assignees_url":"https://api.github.com/repos/celery/celery/assignees{/user}","branches_url":"https://api.github.com/repos/celery/celery/branches{/branch}","tags_url":"https://api.github.com/repos/celery/celery/tags","blobs_url":"https://api.github.com/repos/celery/celery/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/celery/celery/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/celery/celery/git/refs{/sha}","trees_url":"https://api.github.com/repos/celery/celery/git/trees{/sha}","statuses_url":"https://api.github.com/repos/celery/celery/statuses/{sha}","languages_url":"https://api.github.com/repos/celery/celery/languages","stargazers_url":"https://api.github.com/repos/celery/celery/stargazers","contributors_url":"https://api.github.com/repos/celery/celery/contributors","subscribers_url":"https://api.github.com/repos/celery/celery/subscribers","subscription_url":"https://api.github.com/repos/celery/celery/subscription","commits_url":"https://api.github.com/repos/celery/celery/commits{/sha}","git_commits_url":"https://api.github.com/repos/celery/celery/git/commits{/sha}","comments_url":"https://api.github.com/repos/celery/celery/comments{/number}","issue_comment_url":"https://api.github.com/repos/celery/celery/issues/comments{/number}","contents_url":"https://api.github.com/repos/celery/celery/contents/{+path}","compare_url":"https://api.github.com/repos/celery/celery/compare/{base}...{head}","merges_url":"https://api.github.com/repos/celery/celery/merges","archive_url":"https://api.github.com/repos/celery/celery/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/celery/celery/downloads","issues_url":"https://api.github.com/repos/celery/celery/issues{/number}","pulls_url":"https://api.github.com/repos/celery/celery/pulls{/number}","milestones_url":"https://api.github.com/repos/celery/celery/milestones{/number}","notifications_url":"https://api.github.com/repos/celery/celery/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/celery/celery/labels{/name}","releases_url":"https://api.github.com/repos/celery/celery/releases{/id}","deployments_url":"https://api.github.com/repos/celery/celery/deployments","created_at":"2009-04-24T11:31:24Z","updated_at":"2018-03-10T00:04:45Z","pushed_at":"2018-03-10T05:21:21Z","git_url":"git://github.com/celery/celery.git","ssh_url":"git@github.com:celery/celery.git","clone_url":"https://github.com/celery/celery.git","svn_url":"https://github.com/celery/celery","homepage":"http://celeryproject.org","size":46542,"stargazers_count":8858,"watchers_count":8858,"language":"Python","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":true,"forks_count":2526,"mirror_url":null,"archived":false,"open_issues_count":320,"license":{"key":"other","name":"Other","spdx_id":null,"url":null},"forks":2526,"open_issues":320,"watchers":8858,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/celery/celery/pulls/4588"},"html":{"href":"https://github.com/celery/celery/pull/4588"},"issue":{"href":"https://api.github.com/repos/celery/celery/issues/4588"},"comments":{"href":"https://api.github.com/repos/celery/celery/issues/4588/comments"},"review_comments":{"href":"https://api.github.com/repos/celery/celery/pulls/4588/comments"},"review_comment":{"href":"https://api.github.com/repos/celery/celery/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/celery/celery/pulls/4588/commits"},"statuses":{"href":"https://api.github.com/repos/celery/celery/statuses/9f0e59b3c83b51db38e8edf24b57658fe5de4dcc"}},"author_association":"CONTRIBUTOR","merged":false,"mergeable":null,"rebaseable":null,"mergeable_state":"unknown","merged_by":null,"comments":0,"review_comments":0,"maintainer_can_modify":true,"commits":1,"additions":34,"deletions":6,"changed_files":5}}
{"actor":{"display_login":"lpsinger"}}