You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
A possible solution might be to put simple/short docstrings to some of these methods/properties directly and see if it renders in the autodocs and overrides these 'inherited' things.
The text was updated successfully, but these errors were encountered:
The reason for these/this message showing over and over again in several places is that it's taken from the descriptor classes used by a lot of attributes
To prevent that, simply a short comment+colon can be attached after an attribute code line or if desired a description that renders in the docs could be added after it:
attribute = ObjectField() #:
or
attribute = ObjectField() #: Foo description to render in final Sphinx docs...FIXME Syntax allowed here?
Updated the title of this issue. We should go through all our classes, starting with models.py and at least attach #: to all the class attributes. Most of them are self-explanatory anyway. This would help clean up the cluttered module docs described in my first post in this issue.
Some settings in https://github.com/joalla/discogs_client/blob/master/docs/source/conf.py could possibly improved.The autogenerated Python package docs, provided by the Sphinx autodoc extension, somehow copy/inherit one docstring over and over again:E.g:
An attribute that determines its value....
is displayed over and over again:https://python3-discogs-client.readthedocs.io/en/latest/discogs_client.html#discogs_client.models.CollectionFolder
A possible solution might be to put simple/short docstrings to some of these methods/properties directly and see if it renders in the autodocs and overrides these 'inherited' things.
The text was updated successfully, but these errors were encountered: