#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 jhpalmieri):
I propose the following wording:
{{{
#!diff
diff --git a/src/doc/en/developer/coding_basics.rst
b/src/doc/en/developer/coding_basics.rst
index abeb127..298af06 100644
--- a/src/doc/en/developer/coding_basics.rst
+++ b/src/doc/en/developer/coding_basics.rst
@@ -517,7 +517,7 @@ the following are valid::
Return $\sin(x)$.
"""
-**MATH block:** It is similar to LaTeX' syntax ``\[<math expression>\]``
(or
+**MATH block:** This is similar to the LaTeX syntax ``\[<math
expression>\]`` (or
``$$<math expression>$$``). For instance::
.. MATH::
@@ -548,8 +548,12 @@ The **aligned** environment works as it does in
LaTeX::
g(x) & = x^x - f(x - 2)
\end{aligned}
-For **non-math** LaTeX environments (like ``align``), the pdf
documentation
-will not compile unless you add a **:nowrap:** flag to the MATH mode::
+When building the PDF documentation, everything is translated to LaTeX
+and each MATH block is automatically wrapped in a math environment --
+in particular, it is turned into ``\begin{gather} expression
+\end{gather}``. So if you want to use a LaTeX environment (like
+``align``) which in ordinary LaTeX would not be wrapped like this, you
+must add a **:nowrap:** flag to the MATH mode::
.. MATH::
:nowrap:
}}}
I can commit this to the branch if you want, or I can try to review more
and see if there are other changes I want to make first, so we don't have
as many commits.
--
Ticket URL: <http://trac.sagemath.org/ticket/17592#comment:9>
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.
