> Shorter is generally better for headlines, so I'd prefer "Test whether f is 
> foo" over "Return whether f is foo" over "Return ``True`` if f is foo, and 
> ``False`` otherwise".

I hate it when someone documents 'test whether this and that holds'. Or
is there some convention that a test returns true if something holds and
false otherwise?

Suppose you have:

"nonzero(x) tests whether x is zero or not"

What does nonzero return? You have at least 5 possible return values.

  True False 0 1 x

Would everyone interpret in the same way as the documenter actually
wanted it to be interpreted?

Ralf

-- 
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 http://groups.google.com/group/sage-devel.
For more options, visit https://groups.google.com/d/optout.

Reply via email to