#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 ncohen):
That's because of the syntax of python's format thing:
{{{
sage: "a is {a} and b is {b}".format(a=4,b=5)
'a is 4 and b is 5'
}}}
Then you have to know that `__doc__` is the name of the module's docstring
(the string that starts with 'Finite posets'. And then
`gen_rest_table_index` does its job from the class that you give it.
I don't mind your telling me that it is not clear or has to be explained
in the developer's manual: it would be cool if we don't have to explain
how python works there, though.
But then perhaps those details should not appear in the developer's manual
but rather on the module's doc of this `rest_index_of_methods` module.
Nathann
--
Ticket URL: <http://trac.sagemath.org/ticket/19482#comment:7>
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.
