#19482: Documentation for auto-generated index of functions
-------------------------+-------------------------------------------------
Reporter: | Owner:
ncohen | Status: needs_review
Type: | Milestone: sage-6.10
enhancement | Resolution:
Priority: major | Merged in:
Component: | Reviewers:
documentation | Work issues:
Keywords: | Commit:
Authors: | 757a9f4a908db4be170f28a96c000a1358ac9f2d
Nathann Cohen | Stopgaps:
Report Upstream: N/A |
Branch: |
u/ncohen/19482 |
Dependencies: |
-------------------------+-------------------------------------------------
Comment (by jmantysalo):
Back to this one...
I would not say "Optionally, the module's documentation can include a list
- -", but something like "Module documentation should include a list of
all functions. If there are only few of them, the list can be generated -
-".
Maybe after example it could also say something like "The list will not
contain functions that are deprecated or whose name start with
underscore." I am not sure if this is good addition or just noise.
After "An index of **all methods** of a specific class - -" add "There is
no automatic way to get a list of all functions defined in a module
containing several classes."
"When a class/module defines many methods/functions it can become
interesting - -" should be "When a class/module defines many
methods/functions the list should be grouped thematically - -".
Otherwise I think that I have now understood how to use this and what can
be done with automatic indexing.
--
Ticket URL: <http://trac.sagemath.org/ticket/19482#comment:11>
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 https://groups.google.com/group/sage-trac.
For more options, visit https://groups.google.com/d/optout.
