#4906: [with patch, needs review] convert sage.combinat.* docstrings to Sphinx
---------------------------+------------------------------------------------
 Reporter:  mhansen        |       Owner:  tba     
     Type:  defect         |      Status:  new     
 Priority:  major          |   Milestone:  sage-3.4
Component:  documentation  |    Keywords:          
---------------------------+------------------------------------------------

Comment(by hivert):

 New corrections by Vincent Delecroix and myself on the files:
 {{{
  sage/combinat/q_analogues.py
  sage/combinat/ranker.py
  sage/combinat/restricted_growth.py
  sage/combinat/ribbon.py
  sage/combinat/ribbon_tableau.py
 }}}


 == File ranker.py ==

 * Function from_list(l): missing ":" after output + quote
 {{{
 + OUTPUT [rank, unrank] - functions
 }}}
 should be probably
 {{{
 OUTPUT ::
      ``[rank, unrank]`` - functions
 }}}

 == File ribbon_tableau.py ==

 * class RibonTableau_class :: method length(): missing 's' added 'x'
 {{{
 - Returns the length of the ribbons into a ribbon tableau.
 + Return the length of the ribbons into a ribbon tableaux.
 }}}
 * function spin_polynomial_square: missing ">" and "^"
 {{{
 -    length, with the substitution t -> t^2 made.
 +    length, with the substitution t - t2 made.
 }}}

 == File root_system/dynkin_diagram.py ==

 * function column: composed latex subscripts seems to have been lost:
 {{{
 -        of tuples (i, a_{i,j})
 +        (or iterator) of tuples (i, a_i,j)
 ]}}
 should be probably
 {{{
 +        (or iterator) of tuples `(i, a_{i,j})`.
 }}}
 }}}

 * same remark for the function row


 == File root_system/weyl_characters.py ==

 * function branch_weyl_character: lots of problems:
  - input is garlbed:
 {{{
 -    INPUT:
 -       chi - a character of G
 -       R - the Weyl Character Ring of G
 -       S - the Weyl Character Ring of H
 -       rule - a set of r dominant weights in H where r is the rank of G.
 +    INPUT: chi - a character of G R - the Weyl Character Ring of G S -
 +    the Weyl Character Ring of H rule - a set of r dominant weights in
 +    H where r is the rank of G.
 }}}
  - lots of lost > in arrows:
 {{{
 -    connected. This excludes branching rules such as A3 -> A1 x A1, which
 are
 +    connected. This excludes branching rules such as A3 - A1 x A1,
 }}}
  - the rule for branching type are also garbled (three series):
 {{{
 -    ['A',r] -> ['A',r-1]
 -    ['B',r] -> ['A',r-1]
    [...]
 -    ['G',2] -> ['A',1] (short root) (not implemented yet)
 +    ['A',r] - ['A',r-1] ['B',r] - ['A',r-1] ['B',r] - ['B',r-1] ['C',r]
 +    - ['A',r-1] ['C',r] - ['C',r-1] ['D',r] - ['A',r-1] ['D',r] -
 +    ['D',r-1] ['E',r] - ['A',r-1] r = 6,7,8 (not implemented yet)
 +    ['E',r] - ['D',r-1] r = 6,7,8 (not implemented yet) ['E',r] -
 +    ['E',r-1] r = 6,7 (not implemented yet) ['F',4] - ['B',3] (not
 }}}
  - In the example starting with  "Here A3(x,y,z,w) can be understood as a
 representation of SL(4)": missing ">":
 {{{
 -    square representation SL(4) --> GL(6) admits an invariant symmetric
 -    bilinear form, so is a representation SL(4) --> SO(6) that lifts to
 -    an isomorphism SL(4) --> Spin(6).  Conversely, there are two
 -    isomorphisms SO(6) --> SL(4), of which we've selected one.
 +    square representation SL(4) - GL(6) admits an invariant symmetric
 +    bilinear form, so is a representation SL(4) - SO(6) that lifts to
 +    an isomorphism SL(4) - Spin(6). Conversely, there are two
 +    isomorphisms SO(6) - SL(4), of which we've selected one.
 }}}


 == file root_system/weyl_group.py ==

 * function WeylGroup:
 {{{
 +    INPUT: ct - a Cartan Type.
 }}}
 should probably be
 {{{
    INPUT::

        ``ct`` - a Cartan Type.
 }}}

 * function  simple_reflection: typo
 {{{
 +        Returns the `i^th` simple reflection.
 }}}
 should be
 {{{
 +        Returns the `i`-th simple reflection.
 }}}

-- 
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/4906#comment:16>
Sage <http://sagemath.org/>
Sage - Open Source Mathematical Software: Building the Car Instead of 
Reinventing the Wheel

--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups 
"sage-trac" group.
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to 
[email protected]
For more options, visit this group at 
http://groups.google.com/group/sage-trac?hl=en
-~----------~----~----~----~------~----~------~--~---

Reply via email to