#13382: build docs for SymmetricGroupRepresentation(s)
----------------------------------+-----------------------------------------
Reporter: dimpase | Owner: mvngu
Type: defect | Status: needs_work
Priority: major | Milestone: sage-5.4
Component: documentation | Resolution:
Keywords: | Work issues:
Report Upstream: N/A | Reviewers: Volker Braun, Travis
Scrimshaw
Authors: Dima Pasechnik | Merged in:
Dependencies: | Stopgaps:
----------------------------------+-----------------------------------------
Comment (by dimpase):
Replying to [comment:13 tscrim]:
> Replying to [comment:12 dimpase]:
> There are some errors in the documentation build (although no warnings
were given from docbuild). In particular, the examples blocks in
`SpechtRepresentations`, `YoungRepresentations_Orthogonal`,
`YoungRepresentations_Seminormal`, and
`SymmetricGroupRepresentation_generic_class.to_character()`. Also every
instance of a note block doesn't appear to be working, and the
reference(s) aren't linked. Additionally I would put only one instance of
the reference at the beginning of the file.
>
> Once these are fixed then I can give it another review.
I think the problem is in docstrings being put in the wrong places; e.g.
{{{
class YoungRepresentation_Orthogonal(YoungRepresentation_generic):
_default_ring = SR
def __repr__(self):
r"""
String representation of self.
EXAMPLES::
....
}}}
and not like
{{{
class YoungRepresentation_Orthogonal(YoungRepresentation_generic):
r"""
Orthogonal representation of the symmetric group corresponding to...
EXAMPLES::
....
}}}
But I have no idea how the docstrings should be placed when there is more
that one instance of {{{class YoungRepresentation_Orthogonal}}} present.
Hell, I don't even have an idea what this means in Python! Different class
constructors?
Anyhow, the purpose of opening this ticket was to merely put this
functionality in some way into Sage docs, for without it it's simply not
possible to find! Bad documentation is better than no documentation at
all...
How about letting this ticket through, and opening another one, to fix
docstrings in {{{sage/combinat/symmetric_group_representations}}} ?
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/13382#comment:14>
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.
