Fedora 34 Update: python-autoclasstoc-1.3.0-1.fc34
--------------------------------------------------------------------------------
Fedora Update Notification
FEDORA-2022-fbe26e21ee
2022-03-13 18:06:10.996767
--------------------------------------------------------------------------------
Name : python-autoclasstoc
Product : Fedora 34
Version : 1.3.0
Release : 1.fc34
URL : https://github.com/kalekundert/autoclasstoc
Summary : Add a succinct TOC to auto-documented classes
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).
--------------------------------------------------------------------------------
Update Information:
Update `python-vecrec` to 0.3.1; initial package for `python-autoprop`, `python-
signature-dispatch`, and `python-autoclasstoc`.
--------------------------------------------------------------------------------
ChangeLog:
* Wed Mar 2 2022 Benjamin A. Beasley <code(a)musicinmybrain.net> 1.3.0-1
- Initial package (close RHBZ#2038159)
--------------------------------------------------------------------------------
References:
[ 1 ] Bug #2037893 - python-vecrec-0.3.1 is available
https://bugzilla.redhat.com/show_bug.cgi?id=2037893
[ 2 ] Bug #2038159 - Review Request: python-autoclasstoc - Add a succinct TOC to
auto-documented classes
https://bugzilla.redhat.com/show_bug.cgi?id=2038159
[ 3 ] Bug #2038259 - Review Request: python-signature-dispatch - Overload functions
based on their call signature and type annotations
https://bugzilla.redhat.com/show_bug.cgi?id=2038259
[ 4 ] Bug #2038330 - Review Request: python-autoprop - Infer properties from accessor
methods
https://bugzilla.redhat.com/show_bug.cgi?id=2038330
--------------------------------------------------------------------------------
This update can be installed with the "dnf" update program. Use
su -c 'dnf upgrade --advisory FEDORA-2022-fbe26e21ee' at the command
line. For more information, refer to the dnf documentation available at
http://dnf.readthedocs.io/en/latest/command_ref.html#upgrade-command-label
All packages are signed with the Fedora Project GPG key. More details on the
GPG keys used by the Fedora Project can be found at
https://fedoraproject.org/keys
--------------------------------------------------------------------------------