On 2017-05-23 04:16, Nicolas M. Thiery wrote:
> For how to typeset True/False/None/... when we need to spell them out
> explicitly, as already suggested, I would be in favor of :obj:`True`.
I wasn't aware that this works. But in this case, I am in favor (+1) of
:obj:`True` as well.
Best
Daniel
On Wed, May 17, 2017 at 12:32:47PM -0700, Volker Braun wrote:
>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.
Yes, I agree!!! If we want to stick
-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
Kwankyu Lee wrote:
> 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`
X
--
Marc
--
You received this message because you are subscribed to the Google Groups
"sage-devel" group.
To
-1
--
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.
-1 (typesetting adds readability)
--
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
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
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
