#10093: clean up documentation of sage/misc/bitset.pyx
-------------------------------+--------------------------------------------
Reporter: mvngu | Owner: mvngu
Type: enhancement | Status: needs_review
Priority: major | Milestone: sage-4.6.1
Component: documentation | Keywords:
Author: Minh Van Nguyen | Upstream: N/A
Reviewer: | Merged:
Work_issues: |
-------------------------------+--------------------------------------------
Changes (by newvalueoldvalue):
* status: new => needs_review
* author: => Minh Van Nguyen
Old description:
> As the subject says. This ticket is part of the larger project at #7656.
>
> Preliminary patches are up at
>
> * http://github.com/mvngu/10093
>
> Those are not ready for review yet.
New description:
As the subject says. This ticket is part of the larger project at #7656.
--
Comment:
The attached patch is a massive clean-up of the documentation and doctests
in the module `sage/misc/bitset.pyx`. Here's a summary of what's in the
patch:
* Add the title "Bitset" as the title of the module. When generating the
documentation with Sphinx, this name would become the title of the module
in the generated documentation.
* Many typo fixes and remove trailing white spaces.
* Format code according to PEP 008 wherever possible.
* Raise exceptions according to the style of Python 3.x.
* Add lots more doctests to the class documentation of `FrozenBitset`.
* Move input, output documentation from `__init__` in `FrozenBitset` to
the class documentation. This should make the documentation for input and
output appear in the reference manual.
* Cross reference `FrozenBitset` and `Bitset`; provide link to Python's
set types in the Python library reference.
* Explain the string representation of `FrozenBitset` and `Bitset`.
* Get `issubset`, `issuperset` and `isdisjoint` to propagate exceptions;
previously those methods ignored any exceptions raised.
* Illustrate difference between length and capacity of a bitset.
* For `FrozenBitset`, doctests for `None` type in comparison,
containment, union, or, intersection, and, difference, symmetric
difference, xor.
* For `Bitset`, tests for `None` type in `update`, `intersection_update`,
`difference_update`, `symmetric_difference_update`; tests for invalid
input to `add`, `remove`, `discard`.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/10093#comment:3>
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.
