On 2017-05-17 16:07, 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 See the first few lines of [1] where an equivalent of our ``True`` is used (and therefore written in typewriter font) Moreover, in the note box above Section "3.1. Constants added by the site module", it is even done better and a link to Python's True and False is given. (+1 for linking True, False, None to these Python sites. IMO this should be the encouraged way also for Python's exceptions etc.) [1] https://docs.python.org/3/library/constants.html -- 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 [email protected]. To post to this group, send email to [email protected]. Visit this group at https://groups.google.com/group/sage-devel. For more options, visit https://groups.google.com/d/optout.
