---------- Forwarded message ---------- From: John Cremona <john.crem...@gmail.com> Date: 2010/1/18 Subject: Re: [sage-devel] Re: [sage-combinat-devel] sage/combinat/iet/template.py To: sage-devel@googlegroups.com Cc: sage-combinat-de...@googlegroups.com
The other common error is misuse of the :: (double colon) which you should only put immediately before a block of doctests (starting with sage: prompts). So if your EAMPLES block goes right into an example, use EXAMPLES:: but if the first example has some other explanatory text first, keep a single : on EXAMPLES: and put a double :: after that text. John 2010/1/18 Minh Nguyen <nguyenmi...@gmail.com>: > Hi Vincent, > > On Mon, Jan 18, 2010 at 8:41 PM, Vincent Delecroix > <20100.delecr...@gmail.com> wrote: > > <SNIP> > >> Is there anywhere strict specification/possibilities for the docstring >> of functions ? My only source was the devel guide but it does not >> mention the ".. math:" ReST tag > > Ticket #7977 [1] contains a patch that explains how to use the MATH > block. The proposed explanation is to be added to the Developer's > Guide. Thank you very much for pointing out that the Developer's Guide > currently lacks such a description. > > >> and contains two different conventions >> for the OUTPUT part of the docstrings > <SNIP> >> Do we matter of the one we choose ? > > Not really. I think it depends on personal taste. Ticket #7977 also > addresses this issue. > > > [1] http://trac.sagemath.org/sage_trac/ticket/7977 > > -- > Regards > Minh Van Nguyen > > -- > 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 > >
-- 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
