#4902: [with patch, needs review] convert sage.algebras.* docstrings to Sphinx
---------------------------+------------------------------------------------
Reporter: mhansen | Owner: tba
Type: defect | Status: new
Priority: major | Milestone: sage-3.3
Component: documentation | Resolution:
Keywords: |
---------------------------+------------------------------------------------
Comment (by jhpalmieri):
Replying to [comment:3 mhansen]:
> I've posted a patch which takes care of a number of the issues you
noted.
Great, I'll take a look soon.
> Currently, the documentation for "internal" methods that start with "_"
are not included in the reference manual by default. In the future, I
have some ideas for extending Sphinx's autodoc extension to be able to
include things underscore methods without cluttering things up for users
not interested in them.
From Sage's point of view, various classes have a lot of documentation in
the __init__ method, so unfortunately leaving them out means leaving out
some important things. Anyway...
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/4902#comment:5>
Sage <http://sagemath.org/>
Sage - Open Source Mathematical Software: Building the Car Instead of
Reinventing the Wheel
--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups
"sage-trac" group.
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to
[email protected]
For more options, visit this group at
http://groups.google.com/group/sage-trac?hl=en
-~----------~----~----~----~------~----~------~--~---
