Opened 6 years ago

Last modified 6 years ago

#17593 new enhancement

Improve documentation for creating PermutationGroupElement's

Reported by: nthiery Owned by:
Priority: major Milestone: sage-6.5
Component: group theory Keywords:
Cc: ncohen Merged in:
Authors: Reviewers:
Report Upstream: N/A Work issues:
Branch: Commit:
Dependencies: Stopgaps:

Status badges

Description (last modified by nthiery)

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!

Change History (3)

comment:1 Changed 6 years ago by nthiery

  • Summary changed from Improve documentation for creating PermutationGroupElement. to Improve documentation for creating PermutationGroupElement's

comment:2 Changed 6 years ago by nthiery

  • Description modified (diff)

comment:3 Changed 6 years ago by ncohen

  • Cc ncohen added
Note: See TracTickets for help on using tickets.