#14809: Broken docstring for functorial composition of cycle index series
-----------------------------+----------------------------------------------
Reporter: agd | Owner: sage-combinat
Type: defect | Status: new
Priority: minor | Milestone: sage-5.12
Component: combinatorics | Keywords:
Work issues: | Report Upstream: N/A
Reviewers: | Authors:
Merged in: | Dependencies:
Stopgaps: |
-----------------------------+----------------------------------------------
The docstring for the `functorial_composition()` method of the class
`CycleIndexSeries` is broken in three ways:
* Semantically, it leads into an explanation of how the functorial
composition of two cycle index series can be calculated, then stops
abruptly;
* The LaTeX tags are not closed properly, so Sphinx processes some text in
math mode.
* It does not explain what `SimpleGraphSpecies` (the only example) has to
do with anything.
Fixing the second wouldn't fix the first, so I've gone ahead and written a
new docstring which explains what the functorial composition of two
species is and how the associated cycle index is computed, has no
processing errors, and explains the connection to `SimpleGraphSpecies`.
See attached patch.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/14809>
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/groups/opt_out.
