zeitgeist team mailing list archive

[Markus Korn <thekorn@xxxxxx>]

Public bug reported:

The documentation of the Symbol class is in a bad state. It is so bad that it is currently not shown in our public API docs.
This class has not docstring, and has a few (important) undocumented method, we should fix this.
Also we should remove the __doc__ property. This ugly hack was used in our old way of documenting the ontology, but with [0] we won't need it anymore.

[0] lp:~thekorn/zeitgeist/fix-634055-ontology-docs

** Affects: zeitgeist
     Importance: Undecided
         Status: New

-- 
Bad documentation of zeitgeist.datamodel.Symbol
https://bugs.launchpad.net/bugs/640277
You received this bug notification because you are a member of Zeitgeist
Framework Team, which is subscribed to Zeitgeist Framework.

Status in Zeitgeist Framework: New

Bug description:
The documentation of the Symbol class is in a bad state. It is so bad that it is currently not shown in our public API docs.
This class has not docstring, and has a few (important) undocumented method, we should fix this.
Also we should remove the __doc__ property. This ugly hack was used in our old way of documenting the ontology, but with [0] we won't need it anymore.

[0] lp:~thekorn/zeitgeist/fix-634055-ontology-docs