#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: | 216eb972fcb5c224243db440fa0a43c1ec85498c
Nathann Cohen | Stopgaps:
Report Upstream: N/A |
Branch: |
public/17592 |
Dependencies: |
#17589 |
-------------------------+-------------------------------------------------
Comment (by jhpalmieri):
Re your change in the `LaTeX Typesetting` section from
{{{
In ReST documentation, you use backticks \` to mark LaTeX code to be
typeset. In Sage docstrings, you may also use dollar signs instead.
}}}
to
{{{
In ReST documentation LaTeX code is allowed, and is marked with
**backticks or
dollar signs**:
}}}
This is not entirely accurate: in ReST documentation, you can't use dollar
signs; those are only available in Sage's documentation. Maybe say "In
Sage's ReST documentation ..."?
I would also point out that `$$math expression$$` is old-fashioned and
deprecated in LaTeX; `\[math expression]\]$` is much preferred.
Why remove the instructions about `:nowrap:`? Is the warning about it no
longer accurate?
--
Ticket URL: <http://trac.sagemath.org/ticket/17592#comment:2>
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.
