#13605: Partition options and cleanup partitions documentation
------------------------------------------------------+---------------------
       Reporter:  tscrim                              |         Owner:  
sage-combinat
           Type:  enhancement                         |        Status:  
needs_review 
       Priority:  major                               |     Milestone:  
sage-5.8     
      Component:  combinatorics                       |    Resolution:          
     
       Keywords:  partition, options, output, days45  |   Work issues:          
     
Report Upstream:  N/A                                 |     Reviewers:  Andew 
Mathas 
        Authors:  Travis Scrimshaw                    |     Merged in:          
     
   Dependencies:  #14065 #6495 #14063 #13688          |      Stopgaps:          
     
------------------------------------------------------+---------------------

Comment (by andrew.mathas):

 I noticed that the indentation in documentation generated by a
 GlobablOptions class was incorrect. The problem is that because the
 initial and final parts of the documentation are pass to GlobalOptions as
 strings the documentation gets confused if strings have uneven white space
 at the start of different lines.

 I have just pushed a second version of Nicolas' review patch to the
 combinat queue which fixes this.

 Secondly, I noticed that the documentation for
 sage.structure.global_options contains the links
 {{{
     :meth:`~sage.combinat.partition.Partitions.global_options` and
     :meth:`~sage.combinat.tableau.Tableaux.global_options`.
 }}}
 Unfortunately, these do **not** display as links in the manual. Similarly,
 the auto generated doc-strings for a GlobalOption end with
 {{{
 See :class:`~sage.structure.global_options.GlobalOptions` for more
 features of these options.
 }}}
 and this prints as ``GlobalOptions`` in the manual and, again, there is no
 link to the relevant section of the manual. See Partitions.global_options.

 I thought in all of these cases a link should appear, but none of
 variations of this that i have tried make the link appear.

 Hopefully this is caused by my local configuration...if not, then this is
 a minor bug...

-- 
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/13605#comment:45>
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?hl=en.
For more options, visit https://groups.google.com/groups/opt_out.


Reply via email to