#10093: clean up documentation of sage/misc/bitset.pyx
-----------------------------+----------------------------------------------
Reporter: mvngu | Owner: mvngu
Type: enhancement | Status: needs_review
Priority: major | Milestone: sage-4.8
Component: documentation | Keywords:
Work_issues: | Upstream: N/A
Reviewer: | Author: Minh Van Nguyen
Merged: | Dependencies:
-----------------------------+----------------------------------------------
Changes (by mvngu):
* status: needs_work => needs_review
Old description:
> As the subject says. This ticket is part of the larger project at #7656.
>
> '''Apply:'''
>
> * [attachment:trac-10093_cleanup-doc-v2.patch]
New description:
As the subject says. This ticket is part of the larger project at #7656.
'''Apply:'''
* [attachment:trac-10093_cleanup-doc-v3.patch]
--
Comment:
Replying to [comment:7 ncohen]:
> Just two things :
>
> * First, the patch does not apply on rc1, but that's just because of
2 short documentation lines
This should be fixed now with [attachment:trac-10093_cleanup-doc-v3.patch]
[[BR]][[BR]]
> * In the documentation the variable "iter" represents an iterable
from which the FrozenBitset can be created... In Python's terminology, is
an iterator an iterable ? Because in this case checking its length may be
a bad idea... And converting it to a list too perhaps. Well, short of
these two things, this patch is good to go (and great, being Minh's work)
The variable "iter" is meant to signify that the constructor expects an
iterator, something whose elements we can step through one element at a
time. To do the stepping, we need an iterator: a function or something
that allows us to do the stepping through from start to finish. So an
iterable is different from an iterator.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/10093#comment:8>
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 post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/sage-trac?hl=en.
