Changes between Initial Version and Version 2 of Ticket #17593


Ignore:
Timestamp:
01/07/15 09:35:02 (6 years ago)
Author:
nthiery
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • Ticket #17593

    • Property Summary changed from Improve documentation for creating PermutationGroupElement. to Improve documentation for creating PermutationGroupElement's
  • Ticket #17593 – Description

    initial v2  
    11I had a student today that had a bit of difficulty finding the documentation explaining how to create a permutation group element.
    22
    3 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.
     3This 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.
     4In 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.
    45
    56What about moving the documentation on how to create permutation group elements to the class docstring?