Opened 4 years ago

Closed 4 years ago

Last modified 4 years ago

#17424 closed enhancement (fixed)

Index of poset constructors

Reported by: ncohen Owned by:
Priority: major Milestone: sage-6.5
Component: documentation Keywords:
Cc: jmantysalo, nthiery, aschilling Merged in:
Authors: Nathann Cohen Reviewers: Nicolas M. Thiéry
Report Upstream: N/A Work issues:
Branch: 5f790bb (Commits) Commit:
Dependencies: #16526 Stopgaps:

Description

This ticket implements an index of all poset constructors.

Nathann

Change History (18)

comment:1 Changed 4 years ago by ncohen

  • Branch set to u/ncohen/17424
  • Commit set to aef6f774604504222290e65216d013b2f0eae954
  • Status changed from new to needs_review

Last 10 new commits:

7a14585Merge remote-tracking branch 'trac/develop' into ticket/16256
cf463b7Fix doctest (and a typo) after new combinat doc merge.
aef96aaUse more usual ordering for source files in combinat module list.
d365921Do not pretend th module list in combinat doc is in alphabetical order.
06d581fFix links from combinat doc to thematic tutorials.
7b753a2Revert "Fix links from combinat doc to thematic tutorials."
80d548916256: Module List -> Comprehensive Module List and link to trac ticket
f5aa239#16256: fixed links to thematic tutorials
a5208fdtrac #16256: Rewrite the posets doc page
aef6f77trac #17424: Index of all poset constructions

comment:2 follow-up: Changed 4 years ago by nthiery

It's nice looking indeed. What about using "catalog" rather than "index"?

In the long run, it's one more thing that we need to maintain by hand. We should investigate ways to automatize parts of it.

comment:3 in reply to: ↑ 2 ; follow-up: Changed 4 years ago by ncohen

It's nice looking indeed. What about using "catalog" rather than "index"?

Oh. Well, because I named it "index" everywhere else. Index of functions, stuff like that. Change it if you like, but here I used "index" as in "an exhaustive list of things".

In the long run, it's one more thing that we need to maintain by hand. We should investigate ways to automatize parts of it.

Yes. But this is really something which should be done on the Sphinx side. We can do something ourselves (there are some hacks in the listing of graph_generators) but it should really be Sphinx code.

Anyway, in the meantime that should not stop us from building an index for all 'important' classes. These things are useful.

Nathann

comment:4 in reply to: ↑ 3 ; follow-up: Changed 4 years ago by nthiery

Replying to ncohen:

Oh. Well, because I named it "index" everywhere else. Index of functions, stuff like that. Change it if you like, but here I used "index" as in "an exhaustive list of things".

Catalog is used in the following spots :-)

mistral-/opt/sage/src/sage>ls **/*catalog*
algebras/catalog.py                                combinat/crystals/catalog.py          groups/misc_gps/misc_groups_catalog.py
coding/codes_catalog.py                            combinat/designs/design_catalog.py    groups/perm_gps/permutation_groups_catalog.py
combinat/catalog_partitions.py                     groups/affine_gps/catalog.py          matroids/catalog.py
combinat/crystals/catalog_elementary_crystals.py   groups/finitely_presented_catalog.py  matroids/matroids_catalog.py
combinat/crystals/catalog_infinity_crystals.py     groups/groups_catalog.py
combinat/crystals/catalog_kirillov_reshetikhin.py  groups/matrix_gps/catalog.py

Yes. But this is really something which should be done on the Sphinx side.

Definitely.

Anyway, in the meantime that should not stop us from building an index for all 'important' classes. These things are useful.

I will certainly not refrain you or anyone from doing so :-)

Cheers,

comment:5 in reply to: ↑ 4 Changed 4 years ago by ncohen

Yo !

Catalog is used in the following spots :-)

Wanna see how many times "index" appears in Sage's source code ?

mistral-/opt/sage/src/sage>ls **/*catalog*
algebras/catalog.py                                combinat/crystals/catalog.py

Catalog is used a lot indeed, and we usually call "catalog" all the 'things.<tab>' objects. If I make no mistake, what you want to change is the text "Index of constructors" just before the list of them ? In this context I believe that "index" cannot confuse anybody, and I also believe that it is correct as an index is "an exhaustive list of things".

Also, I do not believe that there is any standard with respect to the use of 'catalog' in this context, i.e. a list of methods.

Either way, you can change it if you like. And the same goes for renaming poset_examples to posets_catalog :-P

Nathann

comment:6 follow-up: Changed 4 years ago by jmantysalo

Sidenote: Should we have a checklist for adding a new function? It could contain "Inserted into index (/catalog)" with other things like "Doc contains references to similar functions", "Similar functions contains references to this one" and so on.

comment:7 in reply to: ↑ 6 Changed 4 years ago by ncohen

Sidenote: Should we have a checklist for adding a new function? It could contain "Inserted into index (/catalog)" with other things like "Doc contains references to similar functions", "Similar functions contains references to this one" and so on.

Where do you think it might help ? In the developper's manual ? O_o

There are very very few modules with such an index. Unfortunately.

Nathann

comment:8 Changed 4 years ago by nthiery

  • Branch changed from u/ncohen/17424 to u/nthiery/17424

comment:9 Changed 4 years ago by ncohen

  • Commit changed from aef6f774604504222290e65216d013b2f0eae954 to 5f790bbf0d4ba2c4d0db33cd98ef66c245f051dc

?...


New commits:

5f790bb17424: use the terminology 'catalog' for consistency with our other catalogs of groups, algebras, ...

comment:10 Changed 4 years ago by ncohen

Oh, the commit had not appeared on the list.

Well, no problem with your commit. If you do not have anything else to say to mine you can change the ticket's status.

Nathann

comment:11 Changed 4 years ago by nthiery

  • Status changed from needs_review to positive_review

Positive review, assuming the bot goes green (haven't run the tests myself, but they should be good).

comment:12 Changed 4 years ago by vbraun

  • Status changed from positive_review to needs_work

reviewer name

comment:13 Changed 4 years ago by jmantysalo

Somewhat related: characteristic_polynomial() and to_graph() are not listed in index list on posets.py.

comment:14 Changed 4 years ago by ncohen

Somewhat related: characteristic_polynomial() and to_graph() are not listed in index list on posets.py.

Excellent remark. Perhaps it is time to remove the unclear findstat methods like Poset.to_graph or Graph.to_partition... -_-

Nathann

comment:15 Changed 4 years ago by ncohen

  • Reviewers set to Nicolas Thierry
  • Status changed from needs_work to positive_review

comment:16 Changed 4 years ago by vbraun

  • Branch changed from u/nthiery/17424 to 5f790bbf0d4ba2c4d0db33cd98ef66c245f051dc
  • Resolution set to fixed
  • Status changed from positive_review to closed

comment:17 Changed 4 years ago by kcrisman

  • Commit 5f790bbf0d4ba2c4d0db33cd98ef66c245f051dc deleted
  • Reviewers changed from Nicolas Thierry to Nicolas Thiery

comment:18 Changed 4 years ago by nthiery

  • Reviewers changed from Nicolas Thiery to Nicolas M. Thiéry
Note: See TracTickets for help on using tickets.