#16256: Reorganize the documentation indexes into src/sage/combinat
-------------------------------------+-------------------------------------
       Reporter:  nthiery            |        Owner:
           Type:  enhancement        |       Status:  needs_info
       Priority:  major              |    Milestone:  sage-6.4
      Component:  documentation      |   Resolution:
       Keywords:  combinatorics,     |    Merged in:
  thematic index, quickref           |    Reviewers:
        Authors:  Nicolas M. Thiéry  |  Work issues:  gather comments by
Report Upstream:  N/A                |  showing it around, and work on the
         Branch:                     |  listed TODO's
  u/nthiery/reorganize_the_documentation_indexes_into_src_sage_combinat|       
Commit:
   Dependencies:  #16058             |  2252c4453b5788a3c44fe05100fc0a9f93ea6919
                                     |     Stopgaps:
-------------------------------------+-------------------------------------

Comment (by nthiery):

 Replying to [comment:44 aschilling]:
 > Here are some brief comments:

 Thanks!

 > * In
 
http://sage.math.washington.edu/home/nthiery/sage/src/doc/output/html/en/reference/combinat/sage/combinat/quickref.html
 #sage-combinat-quickref the syntax does not seem right for some of the
 entries.

 All tests pass now :-)

 > I would suggest to also add Tableaux (with usual and some affine
 versions), Cores (perhaps close to Partitions) and Permutations (perhaps
 close to WeylGroups and RootSystems).

 Good point: I have added examples with permutations, tableaux,
 dyckwords, trees. I left out affine tableaux and cores for now, as
 they seem sound to me a bit exotic for a general combinatorics
 quickref. They definitely would make sense in a more specialized
 quickref though.

 What do you think?

 >
 > * I am not sure why all these catalogs are
 > {{{
 >
 >     Catalog Of Crystals
 >     Catalog Of Elementary Crystals
 >     Catalog Of Crystal Models For
 >     Catalog Of Crystal Models For Kirillov-Reshetikhin Crystals
 > }}}
 > are listed separately. The third title seems to be missing something. In
 principle the last three are subsumed under the link "Catalog Of
 Crystals".

 Good point. I removed them.

 By the way: what about removing the definition of crystals from
 sage.combinat.crystals.catalog? It duplicates that of
 sage.combinat.crystals.crystals, and the user interested just in the
 catalog needs to scroll down.

 > * The title "Bases for ." in "Symmetric Functions in Non-Commuting
 Variables" looks weird.
 > * In general, math displays seem to be missing from titles which make
 them look strange and incomplete.

 Indeed: sphinx does not handle math in (references to) titles. Since
 this was already broken beforehand, I was thinking of not fixing this
 in this ticket to avoid being too invasive. Now, if you give me a
 green light for crystals, I can fix those. Idem for the above change
 to the catalog.

 > * The link under "Introductory material" for crystals "Crystals – This
 overview" is broken.

 Fixed. More precisely work around (the usual issue with linking to the
 thematic tutorials).

 > * The alphabetical module list does not seem to be alphabetical.

 It's alphabetical in term of module names, but not module titles. Not
 sure what's the best approach here; possibly including the name of the
 module.

 Cheers,
                                  Nicolas
 ----
 New commits:
 
||[http://git.sagemath.org/sage.git/commit/?id=8602a2d59d6578cde061ab94b76a47c63d127115
 8602a2d]||{{{16256: pass of proofreading on all combinat documentation
 indexes, handling a bunch of TODO's there.}}}||
 
||[http://git.sagemath.org/sage.git/commit/?id=7af0a5d5d319ad00ba2700a7037c1e2664820aaa
 7af0a5d]||{{{16256: improved sage.combinat.quickref}}}||
 
||[http://git.sagemath.org/sage.git/commit/?id=2252c4453b5788a3c44fe05100fc0a9f93ea6919
 2252c44]||{{{16256: improved sage.combinat.crystals's index}}}||

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