https://bugzilla.redhat.com/show_bug.cgi?id=2038159
Bug ID: 2038159
Summary: Review Request: python-autoclasstoc - Add a succinct
TOC to auto-documented classes
Product: Fedora
Version: rawhide
Hardware: All
OS: Linux
Status: NEW
Component: Package Review
Severity: medium
Priority: medium
Assignee: nobody(a)fedoraproject.org
Reporter: code(a)musicinmybrain.net
QA Contact: extras-qa(a)fedoraproject.org
CC: package-review(a)lists.fedoraproject.org
Target Milestone: ---
Classification: Fedora
Spec URL:
https://music.fedorapeople.org/python-autoclasstoc.spec
SRPM URL:
https://music.fedorapeople.org/python-autoclasstoc-1.3.0-1.fc35.src.rpm
Description:
It’s surprisingly difficult to document large Python classes in a way that’s
easy for users to navigate. Most projects use the autodoc Sphinx plugin, which
simply puts the complete documentation for each class member one after another.
While this does fully document the class, it doesn’t give the user a quick way
to see everything the class can do. This makes classes of even moderate
complexity difficult to navigate. It also encourages projects to be stingy
about which class members to include in the documentation (e.g. excluding
special methods, inherited methods, private methods, and/or undocumented
methods), to the further detriment of the user.
What’s needed is for each class to have a succinct table of contents (TOC)
that:
• Is organized into sections that will be meaningful to the user. Different
projects and classes may call for different sections, e.g. public/private
methods, methods that share a decorator, methods with a common prefix, etc.
• Includes every method of the class (so that the documentation is complete),
while still making it easy for the user to get a sense for what the class
does and find what they’re looking for.
• Collapses inherited methods. Complex classes in particular can inherit a
lot of methods from their parent classes, and while these methods should be
present in the TOC (since they’re part of the class), collapsing them makes
it easier for the user to grok the functionality provided by the class
itself.
autoclasstoc provides a new Restructured Text directive that is all of these
things. It also works well with autodoc and autogen, and should be easy to
incorporate into any existing project.
See the complete documentation (
https://autoclasstoc.readthedocs.io/en/latest)
for more information (including examples).
Fedora Account System Username: music
Koji scratch builds:
F36:
https://koji.fedoraproject.org/koji/taskinfo?taskID=80955304
F35:
https://koji.fedoraproject.org/koji/taskinfo?taskID=80955305
F34:
https://koji.fedoraproject.org/koji/taskinfo?taskID=80955306
--
You are receiving this mail because:
You are always notified about changes to this product and component
You are on the CC list for the bug.
https://bugzilla.redhat.com/show_bug.cgi?id=2038159