On Wednesday, May 17, 2017 at 7:07:29 AM UTC-7, Kwankyu Lee wrote: > > We do a poll for adopting an official guideline for docstrings (see > https://trac.sagemath.org/ticket/23017) > -------- > G1. Write > > Return True if something is true. > > but do not write > > Return ``True`` if something is true. > > The same applies to `False` and `None` > -------- > If you agree, flag +1; if you disagree and want it reversed, flag -1; if > you think we do not need this guideline, flag X. >
-1. True is literal code and should be highlighted as such in docstrings. Sphinx/reST markup says that double backquotes are used for "code samples", and that's exactly what this is. -- John -- You received this message because you are subscribed to the Google Groups "sage-devel" group. To unsubscribe from this group and stop receiving emails from it, send an email to sage-devel+unsubscr...@googlegroups.com. To post to this group, send email to sage-devel@googlegroups.com. Visit this group at https://groups.google.com/group/sage-devel. For more options, visit https://groups.google.com/d/optout.
