#5555: [with patch, needs review] make some TeX macros available to docstrings
---------------------------+------------------------------------------------
Reporter: jhpalmieri | Owner: jhpalmieri
Type: enhancement | Status: new
Priority: minor | Milestone: sage-3.4.1
Component: documentation | Keywords:
---------------------------+------------------------------------------------
Comment(by jhpalmieri):
This patch doesn't actually add any examples in the documentation.
However, there are examples, recently added in Sage, which use these
macros:
* in sage/algebras/quatalg/quaternion_algebra.py, the functions
{{{ideal}}}, {{{left_ideal}}} and {{{right_ideal}}} all use \ZZ,
* in sage/rings/polynomial/polynomial_element.pyx, {{{is_primitive}}}
uses \GF{-},
* in sage/schemes/elliptic_curves/ell_rational_field.py,
{{{modular_symbol}}} uses \QQ.
So right now, those docstrings don't appear correctly in the html version
of the reference manual, and they actually produce errors in the pdf
version. If you apply the patches here, those issues should be fixed.
Also as I said earlier:
> You can test this by applying the patch and then putting {{{"\GF{q}"}}}
somewhere in the tutorial, for example, and then type "sage -docbuild
tutorial html" (or "pdf" instead of "html") to check the output, or "sage
-docbuild tutorial latex" to check the LaTeX source code.
Does this answer your question?
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/5555#comment:17>
Sage <http://sagemath.org/>
Sage - Open Source Mathematical Software: Building the Car Instead of
Reinventing the Wheel
--~--~---------~--~----~------------~-------~--~----~
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
-~----------~----~----~----~------~----~------~--~---
