#14184: Fix # optional tags
----------------------------------+-----------------------------------------
       Reporter:  jdemeyer        |         Owner:  mvngu              
           Type:  defect          |        Status:  needs_work         
       Priority:  major           |     Milestone:  sage-5.8           
      Component:  doctest         |    Resolution:                     
       Keywords:                  |   Work issues:                     
Report Upstream:  N/A             |     Reviewers:  Karl-Dieter Crisman
        Authors:  Jeroen Demeyer  |     Merged in:                     
   Dependencies:                  |      Stopgaps:                     
----------------------------------+-----------------------------------------

Comment (by jdemeyer):

 Replying to [comment:11 kcrisman]:
 > I was right - we did change it to the program needed.
 `search_src('ImageMagick')` gets me a lot of hits, particularly in
 plot/animate.py
 > {{{
 > plot/animate.py:430:            sage: a.show()       # optional --
 ImageMagick
 > plot/animate.py:435:            sage: a.show(iterations=3)    # optional
 -- ImageMagick
 > plot/animate.py:439:            sage: a.show(delay=50)        # optional
 -- ImageMagick
 > }}}
 > I think this needs to be uniformized.
 Done, changed all to `optional -- ImageMagick`.

 > By the way, is the `--` versus `-` important?
 No, I used a double dash for consistency here.

 > {{{
 > sage: v, t = qsieve(n, time=True)   # uses the sieve    (optional: time
 doesn't work on cygwin)
 > }}}
 > This line should be changed to "look nice", and now we know why this was
 marked optional.
 Fixed.

 > I believe you are right.  But the doctest makes no sense as an automatic
 doctest in that case.  See [http://hg.sagemath.org/sage-
 main/file/5714ed3eab6a/sage/lfunctions/sympow.py#l116 the relevant note].
 In fact, I get the bizarre (newlines not rendered)
 > {{{
 > sage: a = sympow.L(EllipticCurve('11a'), 2, 16); a
 > "Inertia Group is  C1 MULTIPLICATIVE REDUCTION\nConductor is
 11\n**ERROR** P02L not found in param_data file\nIt can be added with
 './sympow -new_data 2'"
 > }}}
 > So I believe that both of them should probably be made `optional -
 precomputations`, or perhaps even better to add
 > {{{
 > sage: sympow('-new_data 2') # not tested
 > }}}
 > to the doctest and make them all not tested, since by definition someone
 would have to do something "by hand" to make them testable.
 Done.

 > There should also be better error catching there, but I figure anyone
 using sympow knows what they are doing enough to read the documentation -
 or is that worth a ticket as well?
 Technically, it's worth a ticket but I have no plans to work on it.

-- 
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/14184#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?hl=en.
For more options, visit https://groups.google.com/groups/opt_out.


Reply via email to