#10641: fix documentation in sage.misc.package.install_all_optional_packages
-----------------------------+----------------------------------------------
Reporter: agiorgetti | Owner: mvngu
Type: defect | Status: needs_info
Priority: minor | Milestone: sage-4.6.2
Component: documentation | Keywords: days28, beginner
Author: | Upstream: N/A
Reviewer: | Merged:
Work_issues: |
-----------------------------+----------------------------------------------
Changes (by mvngu):
* milestone: => sage-4.6.2
Comment:
Replying to [comment:1 joudinet]:
> I'm trying to fix this bug, but I don't understand what you mean by "the
arguments should be written in verbatim"?
An example is worth a thousand words. I encourage you to actually inspect
the file
{{{
SAGE_ROOT/devel/sage-main/sage/misc/package.py
}}}
to understand how to properly format function arguments and examples. Use
a pair of double back ticks to delimit a word or expression as verbatim,
e.g.
{{{
This word is ``verbatim``.
}}}
See also examples in other source files in the Sage library for more
formatting examples, e.g.
{{{
SAGE_ROOT/devel/sage-main/sage/misc/randstate.pyx
}}}
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/10641#comment:4>
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 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.
