I'd try to avoid the entire construct; Its the linguistic equivalent of
if condition:
return True
else:
return False
Just say "Test condition" in the docstring.
On Wednesday, May 17, 2017 at 4:07:29 PM UTC+2, 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.
>
--
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.
