#4919: [with patch, needs work] convert sage.misc.* docstrings to Sphinx
---------------------------+------------------------------------------------
Reporter: mhansen | Owner: tba
Type: enhancement | Status: new
Priority: major | Milestone: sage-3.3
Component: documentation | Resolution:
Keywords: |
---------------------------+------------------------------------------------
Changes (by jhpalmieri):
* summary: [with patch, needs review] convert sage.misc.* docstrings to
Sphinx => [with patch, needs work] convert
sage.misc.* docstrings to Sphinx
Comment:
I'm not sure why graphs/graph_generators is included in this patch, but
the one change there is minor enough that I can give it a positive
review...
attach.py isn't part of the reference manual, it seems to me. Should it
be? The changes to the source code look fine.
dist.py: looks good.
func_persist.py: looks good.
functional.py: I think lines 428-430 could be deleted, but this is not a
big deal.
lines 943-946: this should be an itemized list (a continuation of the
list of inputs)
getusage.py: looks good.
hg.py: as I mentioned in my review of #4902, methods like {{{__init__}}}
are missing from the html version of the documentation.
lines 415-419: this should be an itemized list (it's been garbled in the
conversion)
same thing for lines 454-461, 534-537, 690-693, 921-922, 947-949,
970-972
line 1035: Sage_ROOT should be SAGE_ROOT
latex.py: this is not really an appropriate issue for this ticket, but in
the conversion to html and/or pdf, can we remove the word "nodetex" when
it appears as a directive in a docstring?
lines 744-750: these look okay as is, but might look better with each
numbered item starting on a new line
log.py: looks good.
misc.py: lines 304-308: should be a list (or two lists, one for input, one
for output)
line 705: need a space between {{{for}}} and {{{"Sage"}}}
lines 718-720: could be deleted (just produces a break in the EXAMPLES).
same for lines 723-725, 728-730, 733-735, 739-741, 749-751, 756-758,
844-846, 850-852.
line 1437: it should say "whether certain integers are >3", but the ">"
was omitted.
line 1453: "positive integer < 100": the "<" was omitted.
line 1629: "fail in Sage <= 1.3.7.": the "<" was omitted.
line 1674: Sage_ROOT should be SAGE_ROOT
mrange.py: looks good.
package.py: lines 126-128 should be an itemized list. same with lines
169-171, 212-214, 256-257
persist.py: looks good.
sage_eval.py: looks good.
trace.py: not part of the reference manual. looks good anyway.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/4919#comment:2>
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
-~----------~----~----~----~------~----~------~--~---
