#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                 |  289b9b89a5c175807fa0c7b315fd00653b53d367
   Dependencies:                     |     Stopgaps:
-------------------------------------+-------------------------------------
Changes (by jhpalmieri):

 * commit:   => 289b9b89a5c175807fa0c7b315fd00653b53d367


Comment:

 The branch currently has two commits. One is brief and contains the main
 code for skipping these blocks. The other is long and does clean up on
 various TESTS blocks scattered through the Sage library. Some of the clean
 up just fixes indentation errors. Some is needed to make the blocks work
 with the skipping code: "TESTS::" (singular or plural, one colon or two)
 must be on a line by itself, so I changed
 {{{
 TESTS: text here::
 }}}
 to
 {{{
 TESTS:

 text here::
 }}}
 Also, the end of a "TESTS" block is detected when we come across a word in
 all capitals followed by a colon ("REFERENCES:") or by a Sphinx directive
 (two dots, space, word, double colon, ".. TODO::"). In some cases, we had
 {{{
 TESTS:

 .. note::
 }}}
 so I moved the ".. note::" to before the test, if that seemed to make
 sense.
 ----
 New commits:
 
||[http://git.sagemath.org/sage.git/commit/?id=f05cc7ab24b33420511092dd58a58ae40144d3d4
 f05cc7a]||{{{Sage library: clean up "TESTS" blocks.}}}||
 
||[http://git.sagemath.org/sage.git/commit/?id=289b9b89a5c175807fa0c7b315fd00653b53d367
 289b9b8]||{{{trac 19503: skip TESTS blocks when doing introspection,}}}||

--
Ticket URL: <http://trac.sagemath.org/ticket/19503#comment:3>
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.

Reply via email to