#17549: Rephrase the 'doctest flags' section of the developer's manual
-------------------------+-------------------------------------------------
       Reporter:         |        Owner:
  ncohen                 |       Status:  needs_review
           Type:         |    Milestone:  sage-6.5
  enhancement            |   Resolution:
       Priority:  major  |    Merged in:
      Component:         |    Reviewers:  Jeroen Demeyer
  documentation          |  Work issues:
       Keywords:         |       Commit:
        Authors:         |  45aadab79b2eceae52a6ade5575848304f1a4048
  Nathann Cohen          |     Stopgaps:
Report Upstream:  N/A    |
         Branch:         |
  u/ncohen/17549         |
   Dependencies:         |
-------------------------+-------------------------------------------------

Comment (by jhpalmieri):

 Replying to [comment:37 vbraun]:
 > What about the `--optional=sage,keyword`? The rationale was that you
 might be able to speed up testing by only running the optional tests, but
 in practice that pretty much never works (since some intermediate steps
 tend to not have the `#optional` tag) and I've never used it. IMHO: Either
 document it clearly or change the behavior.

 I agree that this should be documented.

 > Maybe Karl-Dieter wants to give it a read since he's the only native
 English speaker...

 The English looks okay to me.

 Two more suggestions: we should define relative and absolute tolerance, or
 at least give a link to a definition. Also, maybe we should emphasize that
 the "32-bit" and "64-bit" flags go on the **output** lines, not the input
 lines the way the other flags do. (Either before or after the example:
 "`Note that unlike the other flags, these keywords go on the *output*
 lines, not the input lines.`)

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