Page MenuHomePhabricator
Create Task
Maniphest T130625

param/type of the class constructor aren't shown in the documentation
Closed, ResolvedPublic
Actions

Description

epydoc hides private methods. Class constructor variables are drawn with the class itself but the documentation for the parameters are missing. Maybe this part should be moved from constructor method to the class description.

Details

SubjectRepoBranchLines +/-
[doc] connect 'autodoc-skip-member' hookpywikibot/coremaster+13 -0
docs/conf.py: Configure autodoc to document special methods by defaultpywikibot/coremaster+9 -5
Customize query in gerrit

Event Timeline

Xqt created this task.Mar 22 2016, 3:57 PM
Restricted Application added a project: Documentation. · View Herald TranscriptMar 22 2016, 3:57 PM
Restricted Application added subscribers: pywikibot-bugs-list, Aklapper. · View Herald Transcript
Xqt triaged this task as Low priority.Mar 22 2016, 3:58 PM
Xqt added a project: Proposal.
Tokenzero subscribed.Oct 13 2017, 9:57 PM
Dvorapa added a project: Pywikibot-RfCs.Feb 12 2018, 8:58 PM
gerritbot subscribed.Mar 16 2018, 7:23 AM

Change 419978 had a related patch set uploaded (by Dalba; owner: Dalba):
[pywikibot/core@master] docs/conf.py: Configure autodoc to document special methods by default

https://gerrit.wikimedia.org/r/419978

Restricted Application added a subscriber: Kizule. · View Herald TranscriptMar 16 2018, 7:23 AM
gerritbot added a project: Patch-For-Review.Mar 16 2018, 7:23 AM
gerritbot added a comment.Mar 16 2018, 6:57 PM

Change 419978 merged by jenkins-bot:
[pywikibot/core@master] docs/conf.py: Configure autodoc to document special methods by default

https://gerrit.wikimedia.org/r/419978

Xqt added a comment.Mar 17 2018, 10:44 AM

Showing derived class attributes like __module__ or __weakref__ might be ok after this patch but showinf the __dict__ if the class derive from object directly Looks strange maybe because it is not formated enough.

gerritbot added a comment.Mar 17 2018, 12:29 PM

Change 420168 had a related patch set uploaded (by Xqt; owner: Xqt):
[pywikibot/core@master] [doc] connect 'autodoc-skip-member' hook

https://gerrit.wikimedia.org/r/420168

gerritbot added a comment.Mar 17 2018, 5:27 PM

Change 420168 merged by jenkins-bot:
[pywikibot/core@master] [doc] connect 'autodoc-skip-member' hook

https://gerrit.wikimedia.org/r/420168

Xqt closed this task as Resolved.Mar 17 2018, 6:19 PM
Xqt claimed this task.
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL