#6685: [with patch, needs review] include pictures in the reference manual and
notebook introspection
---------------------------+------------------------------------------------
Reporter: jhpalmieri | Owner: tba
Type: enhancement | Status: new
Priority: major | Milestone: sage-4.1.2
Component: documentation | Keywords:
Reviewer: | Author:
Merged: |
---------------------------+------------------------------------------------
Comment(by ddrake):
Replying to [comment:8 mpatel]:
> Some library authors may wish to include a specific set of pictures in
the reference manual, in part to showcase their code's abilities. If a
media file is not superfluous, but it takes a long time to generate with
Sage, why not include and track it as a binary? We could put some limits
on file sizes or even offer to host them on sage.math and embed them in
the manual.
I'm not terribly opposed to tracking binaries, so in some situation it's
the best thing to do, we should do it. The "image doctest" idea is one
place where we obviously should do this.
> My chief worry is maintaining the correctness and consistency of any
pictures with the code examples. Adding image diffs to doctesting (with
some tolerance) might help, but we would still need to track the binary
"masters." Anyway, this might force contributors to pay attention.
Maintaining correctness and consistency is a major reason why I'd prefer
to have autogenerated stuff. If I've learned anything from the Sage
doctesting philosophy, it's that you can never rely on people to "just
notice" bugs and problems. The only thing people notice, it seems, is "X
failures in..." at the end of a {{{make test}}} run!
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/6685#comment:9>
Sage <http://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 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
-~----------~----~----~----~------~----~------~--~---
