#16570: Animate example looks broken
-------------------------------------+-------------------------------------
Reporter: gagern | Owner:
Type: defect | Status: needs_review
Priority: minor | Milestone: sage-6.3
Component: graphics | Resolution:
Keywords: | Merged in:
Authors: Martin von Gagern | Reviewers:
Report Upstream: N/A | Work issues:
Branch: | Commit:
u/gagern/ticket/16570 | d5155020dc2931d166f360f044a08b7b7bb78b24
Dependencies: | Stopgaps:
-------------------------------------+-------------------------------------
Comment (by gagern):
Replying to [comment:5 ppurka]:
> Can you add a comment about frame size in the documentation itself to
warn the user of bad examples?
Reasonable suggestion, but I'm somewhat uncertain where to put this. I
guess it would be best to put this into the docstring of the whole module.
There it might go after the warning about the need for !ImageMagick or
FFmpeg, or as one of the examples, towards the end.
As a side note, my code from #16571 introduces a doc test which exhibits
the APNG generator complaining about incorrect sizes. Mainly to help
people understand the error message issued in this case.
> Maybe you can even refer to this ticket.
I'd probably word this as follows:
“Note that it is your responsibility to provide frames with matching
sizes. Otherwise the result is undefined: the animation might fail to
save, fail to play back, or simply look strange. Most often you'll want to
ensure common coordinate systems as well, so passing `xmin, xmax, ymin,
ymax` as parameters is quite common. Prior to trac ticket !#16570, one of
the running examples in the documentation violated this requirement:”
Then I'd paste the broken example, but only the construction, without the
command to display it. That way there is not much work for the doctests,
and we can add checks for common frame size to the implementation later on
without breaking that doctest.
In the long run, a better alternative might be not to warn users but to
avoid the unexpected behavior by choosing a common coordinate system
automatically. But that will be more work. I just filed #16654 to keep
track of that idea.
--
Ticket URL: <http://trac.sagemath.org/ticket/16570#comment:6>
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.
