#17593: Improve documentation for creating PermutationGroupElement's
--------------------------------+------------------------
Reporter: nthiery | Owner:
Type: enhancement | Status: new
Priority: major | Milestone: sage-6.5
Component: group theory | Resolution:
Keywords: | Merged in:
Authors: | Reviewers:
Report Upstream: N/A | Work issues:
Branch: | Commit:
Dependencies: | Stopgaps:
--------------------------------+------------------------
Description changed by nthiery:
Old description:
> I had a student today that had a bit of difficulty finding the
> documentation explaining how to create a permutation group element.
>
> This is actualy well documented, but in the `__init__` method of
> PermutationGroupElement. Because of this, when typing
> `PermutationGroupElement?` the user first gets the documentation of the
> class itself (which is currently not particularly useful), and only after
> the useful documentation of the `__init__`. This also means that the
> useful doc does not appear in the html documentation.
>
> What about moving the documentation on how to create permutation group
> elements to the class docstring?
>
> Thanks!
New description:
I had a student today that had a bit of difficulty finding the
documentation explaining how to create a permutation group element.
This is actualy well documented, but in the `__init__` method of
`PermutationGroupElement`. Because of this, when typing
`PermutationGroupElement?` the user first gets the documentation of the
class itself (which is currently not particularly useful), and only after
the useful documentation of the `__init__` method.
In the notebook, the documentation of `__init__` does not even show up.
This also means that the useful doc does not appear at all in the html
documentation.
What about moving the documentation on how to create permutation group
elements to the class docstring?
Thanks!
--
--
Ticket URL: <http://trac.sagemath.org/ticket/17593#comment:2>
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/d/optout.
