On Fri, 22 Aug 2014, Travis Scrimshaw wrote:
Next, short description. There are three different style used
for True/False -functions:
- Returns True if the poset has a unique minimal element.
- Returns True if the poset is totally ordered, and False
otherwise.
- Returns whether f is an EL labelling of self
I'd take the middle one (but starting with "Return") . I forget the link
off-hand, but there is a place in the Sage doc about this.
Seems to be this:
http://www.sagemath.org/doc/developer/coding_basics.html#documentation-strings
There is also a slight inconsistency on this: In the function list there
is written "Returns the order polytope of the poset." wherease function
description says "Return the order polytope of the poset self." Should the
two always be exactly same? If not, when to have different
oneline-description?
Also some functions returns True, others ``True``.
To me it sounds too trivial to say that if function is_something does not
return True then it returns False. Other opinions?
* * *
Finnish "pilkunnussinta" translates directly to "making love with comma
character"... What is right term for messages like this one?
--
Jori Mäntysalo
--
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.
