On Sun, Apr 29, 2012 at 03:17:23PM +0000, Simon King wrote:
> On 2012-04-29, Vincent D <20100.delecr
...@gmail.com> wrote:
> > Hello,
> > In many documentation string (more than a hundred) of the file
> > sage.groups.perm_groups.permgroup_named.py there are many EXAMPLES
> > that are followed by only one ':' and no whiteline after it. It seems
> > that the associated examples are tested with "sage -t" but the
> > documentation looks ugly. Does this need a ticket ?
> Yes! If you create a trac ticket and choose a component, you will find
> that there is a component "documentation", which should be the right one
> for that purpose.
And as usual one should be careful to synchronize well with other
developers working on that file since that's likely to create
conflicts.
Speaking of which, Roberto DiCosmo mentioned the other day a tool to
manipulate meta-patches:
http://www.irill.org/activities/projects/coccinelle
The idea is that instead of writing a patch replacing one by one each
occurrence of ``EXAMPLES:'' by ``EXAMPLES::'' one writes a meta patch
with a single rule specifying that all ``EXAMPLES:'' shall be replaced
with ``EXAMPLES::''. Then the meta patch can apply indifferently on
any version of the sources; and the added semantic opens the door for
more clever merges.
Cheers,
Nicolas
--
Nicolas M. Thi ry "Isil" <nthi...@users.sf.net>
http://Nicolas.Thiery.name/