#18926: Auto-generated index of functions
-------------------------+-------------------------------------------------
Reporter: | Owner:
ncohen | Status: needs_review
Type: | Milestone: sage-6.8
enhancement | Resolution:
Priority: major | Merged in:
Component: | Reviewers:
documentation | Work issues:
Keywords: | Commit:
Authors: | 3a9e3b5cbb00db4ffa5f97542ce3d027b19ee006
Nathann Cohen | Stopgaps:
Report Upstream: N/A |
Branch: |
public/18926 |
Dependencies: |
-------------------------+-------------------------------------------------
Comment (by jsrn):
Hiiiiii Nathann,
> - If you build the documentation of reference/misc...
Oh, sorry, didn't check that. Fixed.
> - Wrong alignment of a paragraph in the documentation of `only_local`,
and some latex code which should be surrounded by two backticks instead of
only one.
Fixed.
> - About `only_local`: I do not understand this doctest about not
including `gen_rest_table_index` in the index of ... its own module. Why
wouldn't `only_local=False` print always more than `only_local=True` in
general? This does not make sense to me.
Yes, it's slightly bizarre. Say you have a catalog module that you wish to
have
an index for. Then you import `gen_rest_table_index` and you call it with
`only_local=False`: you want all the non-local functions, **except
`gen_rest_table_index` itself**. The funny test is then simply to see that
this
is filtered out, without having to rely on another module.
> - I do not understand your mention of 'static' methods.
The function only extracts methods of a class which have been decorated
with
`@staticmethod`. It will not extract methods on *instances* of the class,
i.e.
the normal methods. This was already the semantics in your original
version.
> - Above the 'input' block, a lone line applies to 'classes' only, and
does not take the value 'only_local' into account.
This line was just to clarify the semantics of the function wrt. classes,
since
this surprised me when I first reviewed the ticket. I never intended
`only_local` to have any effect when the function is called on classes.
Johan
----
New commits:
||[http://git.sagemath.org/sage.git/commit/?id=3a9e3b5cbb00db4ffa5f97542ce3d027b19ee006
3a9e3b5]||{{{Yet another docstring fix}}}||
----
New commits:
||[http://git.sagemath.org/sage.git/commit/?id=3a9e3b5cbb00db4ffa5f97542ce3d027b19ee006
3a9e3b5]||{{{Yet another docstring fix}}}||
--
Ticket URL: <http://trac.sagemath.org/ticket/18926#comment:18>
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.
