#16256: Reorganize the documentation indexes into src/sage/combinat
-------------------------------------+-------------------------------------
Reporter: nthiery | Owner:
Type: enhancement | Status: needs_review
Priority: major | Milestone: sage-6.4
Component: documentation | Resolution:
Keywords: combinatorics, | Merged in:
thematic index, quickref | Reviewers:
Authors: Nicolas M. Thiéry | Work issues: Fix sphinx issues.
Report Upstream: N/A | Commit:
Branch: | 2252c4453b5788a3c44fe05100fc0a9f93ea6919
u/nthiery/reorganize_the_documentation_indexes_into_src_sage_combinat|
Stopgaps:
Dependencies: #16058 |
-------------------------------------+-------------------------------------
Comment (by aschilling):
> > * 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 :-)
That is surprising given some of the syntax
{{{
sage: CoxeterGroup(["B",3]).some_flashy_feature()
}}}
or
{{{
sage: M = MultivariatePolynomials('x0,x1,x2,x3')
sage: M(...).action??? S.
}}}
> 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?
That looks good!
> > * 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.
Perhaps I am looking at an old version of the compiled documentation, but
on
http://sage.math.washington.edu/home/nthiery/sage/src/doc/output/html/en/reference/combinat/sage/combinat/crystals/__init__.html
#sage-combinat-crystals
they are still there.
> 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.
Unlike stated on the catalogue site, the documentation does not completely
duplicate the documentation in sage.combinat.crystals.crystals. I suggest
moving it to sage.combinat.crystals.crystals.
This link
http://sage.math.washington.edu/home/nthiery/sage/src/doc/output/html/en/reference/combinat/sage/combinat/crystals/__init__.html
#sage-combinat-crystals
on the crystal quickref site seems to be broken.
The link to sage.combinat.posets on
http://sage.math.washington.edu/home/nthiery/sage/src/doc/output/html/en/reference/combinat/sage/combinat/quickref.html
seems to be broken.
> 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.
Sure.
> > * 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).
For me that link is still broken. I am confused (since you say it is
supposed to be the link to the thematic tutorial): That link appear two
lines below that under
"The Lie Methods and Related Combinatorics thematic tutorial"
Why have two links to the thematic tutorial?
> > * 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.
That is very confusing to the user and developer since it says explicitly
"alphabetical". From just looking at the list, it is not clear that the
modules are listed alphabetical. Please include the name of the module or
not flatten the list.
Best,
Anne
--
Ticket URL: <http://trac.sagemath.org/ticket/16256#comment:51>
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.
