#17592: rephrase "LaTeX formating" and "Writing doctests"
-------------------------+-------------------------------------------------
Reporter: | Owner:
ncohen | Status: needs_review
Type: | Milestone: sage-6.5
enhancement | Resolution:
Priority: major | Merged in:
Component: | Reviewers:
documentation | Work issues:
Keywords: | Commit:
Authors: | 84a8b233a6602a644eb63541d4846aa832e2d22b
Nathann Cohen | Stopgaps:
Report Upstream: N/A |
Branch: |
public/17592 |
Dependencies: |
#17589 |
-------------------------+-------------------------------------------------
Comment (by ncohen):
Hello John !
No problem for your first modification. As for the second, I had dropped
on purpose the explanation about 'wrapping' as it made no sense that it
applied only to pdf and not to html. ALso, I did not want to go in such
depth about something which is very very very marginally useful to us (one
instance in all of Sage's code!) and really seems to be a bug more than
anything else. What would you think of only keeping your second sentence ?
Something like:
{{{
#!diff
+ When building the PDF documentation, a LaTeX environment which should
not appear in math mode (e.g. ``align``) may become a problem. In order to
use them, you will have to add a `:nowrap:` flag::
}}}
While I prefer a short sentence like that, I will be okay with whatever
you decide on this respect. My only aim is to make it easy to read and to
use, and I often worry about not dragging people into reading things that
are of no interest to them (which explains the bold words I add
everywhere).
If you can take the time to do a full review of this branch this will
probably make my life easier; fixing everything at once is much less work.
Thanks,
Nathann
--
Ticket URL: <http://trac.sagemath.org/ticket/17592#comment:10>
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.
