EXAMPLES in perm_group_named.py

[Vincent D]

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 ?

Best,
Vincent

[William Stein]

Yes - it was surely missed by the automated conversion to Sphinx a long time ago.

 

Best,
Vincent

--
To post to this group, send an email to sage-...@googlegroups.com
To unsubscribe from this group, send an email to sage-devel+...@googlegroups.com
For more options, visit this group at http://groups.google.com/group/sage-devel
URL: http://www.sagemath.org

--
William Stein
Professor of Mathematics
University of Washington
http://wstein.org

[Simon King]

Hi!

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.

Best regards,
Simon

[Nicolas M. Thiery]

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" <nth...@users.sf.net>
http://Nicolas.Thiery.name/