#6630: [with patch, needs work] The empty species exists !!!
----------------------------+-----------------------------------------------
Reporter: hivert | Owner: hivert
Type: defect | Status: assigned
Priority: major | Milestone: sage-4.1.2
Component: combinatorics | Keywords: species zero
Reviewer: Franco Saliola | Author: Florent Hivert
Merged: |
----------------------------+-----------------------------------------------
Comment(by mvngu):
The patch `trac_6630-reviewer.patch` fixes a number of typos found in
`empty_species-fh-6630.patch`. It also adds the new module
`sage/combinat/species/empty_species.py` to the reference manual; the
module is too good to be buried among the source files of the Sage
library! In adding the module to the reference manual, the patch fixes
some ReST formatting typos. The docstring of the function `EmptySpecies()`
has been moved to the class `EmptySpecies_class`. This is so that
docstrings for empty species show up in the reference manual.
[[BR]][[BR]]
The following private methods have doctests, but no docstrings:
1. `__init__()`
1. `_gs()`
1. `_structures()`
This lack of docstring would come back to haunt the documentation writer
and user because when #6586 is merged then private methods would show up
in the reference manual. So two things remain to be done:
1. Someone needs to review the patch `trac_6630-reviewer.patch`.
1. Add docstrings to the above private methods. One easy way to do so is
to first apply `empty_species-fh-6630.patch`, followed by
`trac_6630-reviewer.patch`. Then write docstrings based upon those two
patches and upload another patch. I'm marking this ticket as "needs work".
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/6630#comment:5>
Sage <http://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
-~----------~----~----~----~------~----~------~--~---
