Hi Florent,
On 23 Apr., 15:27, Florent Hivert <florent.hiv...@univ-rouen.fr>
wrote:
> Now here is a random and non exhaustive lists of common mistakes:
>
> 1 - Do NOT indent bullet lists (unless you want extra indentation) and leave a
> blank line at the end as
> """
> INPUT:
>
> - ``self`` -- bla bla
> - ``opts`` -- ...
>
> More text
> """
> and not
> """
> INPUT:
> - ``self`` -- bla bla
> - ``opts`` -- ...
> More text
> """
>
> 2 - with multi-line explicit markup (note, warning, rubric, seealso...), the
> following alignment must be respected
> """
> .. seealso:: :class:`FinitePosets`, :class:`Lattices`,
> :class:func:`LatticePoset`
> """
> and not
> """
> .. seealso:: :class:`FinitePosets`, :class:`Lattices`,
> :class:func:`LatticePoset`
> """
>
> 3 - When using LaTeX markup (`...`) make sure to prefix the docstring with a r
> to prevent control character expansion:
> r"""
> \right is not interpreted as \r + right
> """
> Actually, I think that we should systematically prefix docstring with r.
At least, there should be an r in front of the doc string if it
contains any backslash.
There is another quite common mistake:
It should be
EXAMPLE::
sage: bla
and not
EXAMPLE:
sage: bla
Just to avoid duplication of work: We killed a bunch of those mistakes
in #9976.
Cheers,
Simon
--
To post to this group, send an email to sage-devel@googlegroups.com
To unsubscribe from this group, send an email to
sage-devel+unsubscr...@googlegroups.com
For more options, visit this group at http://groups.google.com/group/sage-devel
URL: http://www.sagemath.org
