#19503: strip TESTS blocks in introspection
-------------------------------------+-------------------------------------
Reporter: jhpalmieri | Owner:
Type: enhancement | Status: needs_review
Priority: major | Milestone: sage-6.10
Component: documentation | Resolution:
Keywords: | Merged in:
Authors: John Palmieri | Reviewers:
Report Upstream: N/A | Work issues:
Branch: | Commit:
u/jhpalmieri/TESTS | c659e025d483d55b4bf644fa2f367884c7a2ca20
Dependencies: | Stopgaps:
-------------------------------------+-------------------------------------
Comment (by jhpalmieri):
By the way, there are many instances in the Sage library of top-level
documentation looking like
{{{
"""
blah
blah
Classes and methods
-------------------
"""
}}}
so that the page in the reference manual has a nice header but it looks
silly if you look at this via introspection. I would suggest that if we
want to change this, it belongs on another ticket. My goal here was to
preserve the current look of the reference manual and help strings while
removing only the TESTS blocks. So I would prefer not deleting "Classes
and methods" and similar strings here.
To find other instances of this, do
{{{
sage: search_src('(---|===)\n"""', multiline=True)
}}}
I got 97 hits when I did this search.
--
Ticket URL: <http://trac.sagemath.org/ticket/19503#comment:20>
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/d/optout.
