-1, for reasons that have already been explained by others. Generally, any reference to a programmatical object should be typographically distinguished from normal text. Hence, it should be "Let `f(x)` be the function that returns ``True`` if `x>0` and ``False`` otherwise." but not "Let f(x) be the function that returns True if x>0 and False otherwise."
Cheers, Simon On 2017-05-17, Kwankyu Lee <ekwan...@gmail.com> 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. > -- 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.