#11263: Markup ".. link" is wrong in the developer guide. Add ".. linkall" to
systematically link.
-----------------------------+----------------------------------------------
Reporter: hivert | Owner: hivert
Type: defect | Status: needs_review
Priority: major | Milestone: sage-4.7.1
Component: documentation | Keywords: developer link skip markup
Work_issues: | Upstream: N/A
Reviewer: John Palmieri | Author: Florent Hivert
Merged: | Dependencies:
-----------------------------+----------------------------------------------
Old description:
> The developer guide says:
> {{{
> To link together verbatim environments, use the .. link:: comment.
> }}}
> whereas the correct markup is {{{.. link}}} without {{{::}}}
> same for {{{.. skip}}}
>
> I also add a new markup {{{.. linkall}}} which doesn't split the various
> block anymore.
>
> == Apply ==
>
> * [attachment:trac_11263-doctests_link_all-fh.patch] to Sage's library
> * [attachment:trac_11263-doctests_link_all-SAGE.local.bin-fh.patch] to
> {{{SAGE_ROOT/local/bin}}}
New description:
The developer guide says:
{{{
To link together verbatim environments, use the .. link:: comment.
}}}
whereas the correct markup is {{{.. link}}} without {{{::}}}
same for {{{.. skip}}}
I also add a new markup {{{.. linkall}}} which doesn't split the various
block anymore.
== Apply ==
* [attachment:trac_11263-doctests_link_all-fh.patch] to Sage's library
* [attachment:trac_11263-second.patch] to Sage's library
* [attachment:trac_11263-doctests_link_all-SAGE.local.bin-fh.patch] to
{{{SAGE_ROOT/local/bin}}}
--
Comment(by jhpalmieri):
Here's a patch which modifies the wording in the developer's guide, plus
it adds an example of using ".. linkall" (to a file in the tutorial).
Florent, I'm happy with your changes. If you're okay with mine, you can
give the whole ticket a positive review.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/11263#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 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.
