#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:         |  5fc4e9e9bffe705a66386bce27655da00727bd1a
  Nathann Cohen          |     Stopgaps:
Report Upstream:  N/A    |
         Branch:         |
  public/18926           |
   Dependencies:         |
-------------------------+-------------------------------------------------

Comment (by ncohen):

 Helloooooo Johan,

 I have several remarks about your commits:

 - If you build the documentation of reference/misc, you will notice that
 the description (in the index) of `gen_rest_table_index` is unfinished:
 only the first line is taken into account (see
 http://doc.sagemath.org/html/en/developer/coding_basics.html#the-
 docstring-of-a-function-content)

 - 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.

 - 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.

 - I do not understand your mention of 'static' methods.

 - Above the 'input' block, a lone line applies to 'classes' only, and does
 not take the value 'only_local' into account.

 Nathann

--
Ticket URL: <http://trac.sagemath.org/ticket/18926#comment:15>
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.

Reply via email to