zeitgeist team mailing list archive

[Siegfried Gevatter <rainct@xxxxxxxxxx>]

*** This bug is a duplicate of bug 634055 ***
    https://bugs.launchpad.net/bugs/634055

** Changed in: zeitgeist
       Status: Confirmed => Fix Committed

** Changed in: zeitgeist
     Assignee: Seif Lotfy (seif) => (unassigned)

** This bug has been marked a duplicate of bug 634055
   documentation of our ontology is hardly readable
 * You can subscribe to bug 634055 by following this link: https://bugs.edge.launchpad.net/zeitgeist/+bug/634055/+subscribe

-- 
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: Fix Committed

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