#19041: Better description of docstrings in the developer guide
-------------------------------------+-------------------------------------
Reporter: vdelecroix | Owner:
Type: enhancement | Status: needs_review
Priority: major | Milestone: sage-6.9
Component: documentation | Resolution:
Keywords: | Merged in:
Authors: Vincent | Reviewers: Nathann Cohen
Delecroix, Jori Mäntysalo | Work issues:
Report Upstream: N/A | Commit:
Branch: | d01d36d74b80e44b6676c82b5ae02247e3200e30
u/jmantysalo/19041 | Stopgaps:
Dependencies: |
-------------------------------------+-------------------------------------
Comment (by dkrenn):
Replying to [comment:30 jmantysalo]:
> Should we avoid technically exact term "iterable" and just say "list"
instead?
IMHO, no. If an iterable is possible, then this should be stated. In
particular since Python 3 uses a lot more iterables/iterators and thus
iterable is a very basic Python vocabulary ;)
Also writing something unprecise or incomplete is also not a good idea.
> On posets `is_linear_extension()` says on `INPUT` block "l – a list (or
iterable) containing - -". I think that it is easier for beginner to
understand, and advanced user knows that Sage almost never checks for
exact type.
I find this good, since it says list (the beginner will know what this
is), but also mentions iterable, so this it is clear that iterables are
allowed and the advanced user and iterator-loving user will be happy :)
--
Ticket URL: <http://trac.sagemath.org/ticket/19041#comment:31>
Sage <http://www.sagemath.org>
Sage: Creating a Viable Open Source Alternative to Magma, Maple, Mathematica,
and MATLAB
--
You received this message because you are subscribed to the Google Groups
"sage-trac" 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 http://groups.google.com/group/sage-trac.
For more options, visit https://groups.google.com/d/optout.
