#15096: corrupted documentation (global fix)
--------------------------+------------------------------------------------
Reporter: | Owner:
zimmerma | Status: closed
Type: defect | Milestone: sage-duplicate/invalid/wontfix
Priority: | Resolution: wontfix
trivial | Merged in:
Component: | Reviewers: Paul Zimmermann, Minh Van Nguyen
documentation | Work issues:
Keywords: | Commit:
Authors: | Stopgaps:
Report Upstream: N/A |
Branch: |
Dependencies: |
--------------------------+------------------------------------------------
Comment (by jhpalmieri):
I think that the issue is not, for the most part, people producing
incorrectly formatted docstrings, but rather docstrings dating from the
pre-Sphinx days which used the old style of
{{{
EXAMPLE:
sage: ...
}}}
So maybe a better option is to change the `sphinxify` function (which I
think is responsible for producing these formatted docstrings) to replace
"EXAMPLE(S?):\n text" with "EXAMPLES::\n\n text". That change should be an
easy regexp operation and should fix most of these problems.
(Of course, if it's not `sphinxify`, then fix the relevant function...)
--
Ticket URL: <http://trac.sagemath.org/ticket/15096#comment:13>
Sage <http://www.sagemath.org>
Sage: Creating a Viable Open Source Alternative to Magma, Maple, Mathematica,
and MATLAB
--
You received this message because you are subscribed to the Google Groups
"sage-trac" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/sage-trac.
For more options, visit https://groups.google.com/groups/opt_out.
