#2364: [with patch, needs work] animate .show() method is poorly documented
---------------------------------------------+------------------------------
Reporter: cwitty | Owner: tba
Type: defect | Status: new
Priority: major | Milestone: sage-3.2.1
Component: documentation | Resolution:
Keywords: animate, documentation, doctest |
---------------------------------------------+------------------------------
Comment (by mabshoff):
Replying to [comment:11 jhpalmieri]:
> Oh dear. I don't know how to write the doctests, then. For example, I
have a doctest which shows what happens when {{{convert}}} is missing:
> {{{
> If ImageMagick is not installed, you will get an error message:
> sage: a.gif() # optional
> /usr/local/share/sage/local/bin/sage-native-execute: 8:
convert: not
> found
>
> Error: ImageMagick does not appear to be installed. Saving
an
> animation to a GIF file or displaying an animation requires
> ImageMagick, so please install it and try again.
>
> See www.imagemagick.org, for example.
> }}}
> This will fail if you run the optional doctests with {{{convert}}}
installed. Should I delete the doctest and just display the error
message?
Nope, if someone runs optional doctests and the binary required is not
there it will blow up. Nothing can change that until we have a more clever
"#optinal" doctest treatment.
> Also, I have doctests like this
> {{{
> sage: a.save(show_path=True) # optional
> Animation saved to file /home/isaac/.sage/sage0.gif.
> }}}
> in which I have inserted an invented pathname. What should I do about
these?
This would need to be changed to
"Animation saved to file .../sage0.gif."
Cheers,
Michael
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/2364#comment:12>
Sage <http://sagemath.org/>
Sage - Open Source Mathematical Software: Building the Car Instead of
Reinventing the Wheel
--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups
"sage-trac" group.
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to [EMAIL PROTECTED]
For more options, visit this group at
http://groups.google.com/group/sage-trac?hl=en
-~----------~----~----~----~------~----~------~--~---
