Edit comprehensive module list

Author: kwankyu

src/doc/en/reference/combinat/index.rst

@@ -14,5 +14,12 @@ Comprehensive Module List
 
    module_list
 
+See also
+
+.. toctree::
+    :maxdepth: 1
+
+    sage/rings/cfinite_sequence
+
 .. include:: ../footer.txt
 

src/doc/en/reference/combinat/module_list.rst

@@ -1,14 +1,16 @@
 Comprehensive Module List
 =========================
 
-.. This list is currently sorted in alphabetical order with respect to the module names.
-   It can be updated semi-automatically by running in ``src/sage/combinat``::
+.. NOTE::
 
-       find . -type f \( -name "*.py" -o -name "*.pyx" \) | sed 's/\.pyx\?$//; s|^\./|    sage/combinat/|' | LC_ALL=C sort > /tmp/module_list.rst
+    This list is currently sorted in alphabetical order with respect to the module names.
+    It can be updated semi-automatically by running in ``src/sage/combinat``::
 
-   and copy pasting the result back there.
+        find . -type f \( -name "*.py" -o -name "*.pyx" \) | sed 's/\.pyx\?$//; s|^\./|    sage/combinat/|' | LC_ALL=C sort > /tmp/module_list.rst
 
-   See Issue #17421 for desirable improvements.
+    and copy pasting the result back there.
+
+    See :issue:`17421` for desirable improvements.
 
 .. toctree::
     :maxdepth: 1
@@ -140,7 +142,6 @@ Comprehensive Module List
     sage/combinat/growth
     sage/combinat/hall_polynomial
     sage/combinat/hillman_grassl
-    sage/combinat/integer_lists/__init__
     sage/combinat/integer_lists/base
     sage/combinat/integer_lists/invlex
     sage/combinat/integer_lists/lists

src/sage/combinat/SJT.py

@@ -1,4 +1,6 @@
 r"""
+The Steinhaus-Johnson-Trotter algorithm
+
 The Steinhaus-Johnson-Trotter algorithm generates all permutations of a list in
 an order such that each permutation is obtained by transposing two adjacent
 elements from the previous permutation.

src/sage/combinat/blob_algebra.py

@@ -1,6 +1,6 @@
 # sage.doctest: needs sage.combinat sage.modules
 r"""
-Blob Algebras
+Blob algebras
 
 AUTHORS:
 

src/sage/combinat/cartesian_product.py

@@ -1,5 +1,5 @@
 r"""
-Cartesian Products
+Cartesian products
 """
 # ****************************************************************************
 #       Copyright (C) 2007 Mike Hansen <[email protected]>,

src/sage/combinat/cluster_algebra_quiver/cluster_seed.py

@@ -1,27 +1,33 @@
 # sage.doctest: needs sage.graphs sage.modules
 r"""
-ClusterSeed
+Cluster seeds
 
-A *cluster seed* is a pair `(B,\mathbf{x})` with `B` being a *skew-symmetrizable* `(n+m) \times n` *-matrix*
-and with `\mathbf{x}` being an `n`-tuple of *independent elements* in the field of rational functions in `n` variables.
+A *cluster seed* is a pair `(B,\mathbf{x})` with `B` being a
+*skew-symmetrizable* `(n+m) \times n` *-matrix* and with `\mathbf{x}` being an
+`n`-tuple of *independent elements* in the field of rational functions in `n`
+variables.
 
 For the compendium on the cluster algebra and quiver package see
 [MS2011]_.
 
-AUTHORS:
-
-- Gregg Musiker: Initial Version
-- Christian Stump: Initial Version
-- Aram Dermenjian (2015-07-01): Updating ability to not rely solely on clusters
-- Jesse Levitt (2015-07-01): Updating ability to not rely solely on clusters
-
 REFERENCES:
 
 - [FZ2007]_
-
 - [BDP2013]_
 
-.. SEEALSO:: For mutation types of cluster seeds, see :meth:`sage.combinat.cluster_algebra_quiver.quiver_mutation_type.QuiverMutationType`. Cluster seeds are closely related to :meth:`sage.combinat.cluster_algebra_quiver.quiver.ClusterQuiver`.
+.. SEEALSO::
+
+    For mutation types of cluster seeds, see
+    :meth:`sage.combinat.cluster_algebra_quiver.quiver_mutation_type.QuiverMutationType`.
+    Cluster seeds are closely related to
+    :meth:`sage.combinat.cluster_algebra_quiver.quiver.ClusterQuiver`.
+
+AUTHORS:
+
+- Gregg Musiker: initial version
+- Christian Stump: initial version
+- Aram Dermenjian (2015-07-01): updating ability to not rely solely on clusters
+- Jesse Levitt (2015-07-01): updating ability to not rely solely on clusters
 """
 
 # ****************************************************************************

src/sage/combinat/cluster_algebra_quiver/interact.py

@@ -1,3 +1,7 @@
+r"""
+Interactive window for cluster seed mutations
+"""
+
 import ipywidgets as widgets
 from sage.misc.latex import latex
 from sage.repl.rich_output.pretty_print import pretty_print

src/sage/combinat/colored_permutations.py

@@ -1,5 +1,5 @@
 r"""
-Colored Permutations
+Colored permutations
 
 .. TODO::
 

src/sage/combinat/composition_signed.py

@@ -1,5 +1,5 @@
 r"""
-Signed Compositions
+Signed compositions
 """
 # ****************************************************************************
 #       Copyright (C) 2007 Mike Hansen <[email protected]>,

src/sage/combinat/composition_tableau.py

@@ -1,9 +1,9 @@
 r"""
-Composition Tableaux
+Composition tableaux
 
 AUTHORS:
 
-- Chris Berg, Jeff Ferreira (2012-9): Initial version
+- Chris Berg, Jeff Ferreira (2012-9): initial version
 """
 from sage.sets.disjoint_union_enumerated_sets import DisjointUnionEnumeratedSets
 from sage.sets.non_negative_integers import NonNegativeIntegers

src/sage/combinat/crystals/affine.py

@@ -1,6 +1,6 @@
 # sage.doctest: needs sage.combinat sage.modules
 r"""
-Affine Crystals
+Affine crystals
 """
 # ****************************************************************************
 #       Copyright (C) 2008 Brant Jones <brant at math.ucdavis.edu>

src/sage/combinat/crystals/affinization.py

@@ -1,6 +1,6 @@
 # sage.doctest: needs sage.combinat sage.modules
 r"""
-Affinization Crystals
+Affinization crystals
 """
 
 #*****************************************************************************

src/sage/combinat/crystals/catalog.py

@@ -1,5 +1,5 @@
 r"""
-Catalog Of Crystals
+Catalog of crystals
 
 Let `I` be an index set and let `(A,\Pi,\Pi^\vee,P,P^\vee)` be a Cartan datum
 associated with generalized Cartan matrix `A = (a_{ij})_{i,j\in I}`.  An

src/sage/combinat/crystals/catalog_elementary_crystals.py

@@ -1,5 +1,5 @@
 """
-Catalog Of Elementary Crystals
+Catalog of elementary crystals
 
 See :mod:`~sage.combinat.crystals.elementary_crystals`.
 

src/sage/combinat/crystals/catalog_infinity_crystals.py

@@ -1,5 +1,5 @@
 r"""
-Catalog Of Crystal Models For `B(\infty)`
+Catalog of crystal models For `B(\infty)`
 
 We currently have the following models:
 

src/sage/combinat/crystals/catalog_kirillov_reshetikhin.py

@@ -1,5 +1,5 @@
 """
-Catalog Of Crystal Models For Kirillov-Reshetikhin Crystals
+Catalog of crystal models for Kirillov-Reshetikhin crystals
 
 We currently have the following models:
 

src/sage/combinat/crystals/direct_sum.py

@@ -1,8 +1,8 @@
 # sage.doctest: needs sage.combinat sage.modules
 """
-Direct Sum of Crystals
+Direct sum of crystals
 """
-#*****************************************************************************
+# ****************************************************************************
 #       Copyright (C) 2010 Anne Schilling <anne at math.ucdavis.edu>
 #
 #  Distributed under the terms of the GNU General Public License (GPL)
@@ -15,7 +15,7 @@
 #  The full text of the GPL is available at:
 #
 #                  http://www.gnu.org/licenses/
-#****************************************************************************
+# ***************************************************************************
 
 from sage.categories.category import Category
 from sage.sets.disjoint_union_enumerated_sets import DisjointUnionEnumeratedSets

src/sage/combinat/crystals/elementary_crystals.py

@@ -1,6 +1,6 @@
 # sage.doctest: needs sage.combinat sage.modules
 r"""
-Elementary Crystals
+Elementary crystals
 
 Let `\lambda` be a weight. The crystals `T_{\lambda}`, `R_{\lambda}`, `B_i`,
 and `C` are important objects in the tensor category of crystals.

src/sage/combinat/crystals/fast_crystals.py

@@ -1,6 +1,6 @@
 # sage.doctest: needs sage.combinat sage.modules
 r"""
-Fast Rank Two Crystals
+Fast rank two crystals
 """
 # ****************************************************************************
 #       Copyright (C) 2007 Anne Schilling <anne at math.ucdavis.edu>

src/sage/combinat/crystals/generalized_young_walls.py

@@ -1,14 +1,6 @@
 # sage.doctest: needs sage.combinat sage.modules
 r"""
-Crystals of Generalized Young Walls
-
-AUTHORS:
-
-- Lucas David-Roesler: Initial version
-
-- Ben Salisbury: Initial version
-
-- Travis Scrimshaw: Initial version
+Crystals of generalized Young walls
 
 Generalized Young walls are certain generalizations of Young tableaux
 introduced in [KS2010]_ and designed to be a realization of the crystals
@@ -18,6 +10,12 @@
 
 - [KLRS2016]_
 - [KS2010]_
+
+AUTHORS:
+
+- Lucas David-Roesler: initial version
+- Ben Salisbury: initial version
+- Travis Scrimshaw: initial version
 """
 
 # *****************************************************************************

src/sage/combinat/crystals/induced_structure.py

@@ -1,12 +1,12 @@
 # sage.doctest: needs sage.combinat sage.modules
 r"""
-Induced Crystals
+Induced crystals
 
 We construct a crystal structure on a set induced by a bijection `\Phi`.
 
 AUTHORS:
 
-- Travis Scrimshaw (2014-05-15): Initial implementation
+- Travis Scrimshaw (2014-05-15): initial implementation
 """
 
 #*****************************************************************************

src/sage/combinat/crystals/infinity_crystals.py

@@ -1,15 +1,14 @@
 # sage.doctest: needs sage.combinat sage.modules
 r"""
-`\mathcal{B}(\infty)` Crystals of Tableaux in Nonexceptional Types and `G_2`
+`\mathcal{B}(\infty)` crystals of tableaux in nonexceptional types and `G_2`
 
 A tableau model for `\mathcal{B}(\infty)`. For more information, see
 :class:`~sage.combinat.crystals.infinity_crystals.InfinityCrystalOfTableaux`.
 
 AUTHORS:
 
-- Ben Salisbury: Initial version
-
-- Travis Scrimshaw: Initial version
+- Ben Salisbury: initial version
+- Travis Scrimshaw: initial version
 """
 
 #*****************************************************************************

src/sage/combinat/crystals/kirillov_reshetikhin.py

@@ -1,6 +1,6 @@
 # sage.doctest: needs sage.combinat sage.modules
 r"""
-Kirillov-Reshetikhin Crystals
+Kirillov-Reshetikhin crystals
 """
 
 # ****************************************************************************

src/sage/combinat/crystals/kyoto_path_model.py

@@ -1,9 +1,9 @@
 # sage.doctest: needs sage.combinat sage.modules
 r"""
-Kyoto Path Model for Affine Highest Weight Crystals
+Kyoto path model for affine highest weight crystals
 """
 
-#*****************************************************************************
+# ***************************************************************************
 #       Copyright (C) 2013 Travis Scrimshaw <tscrim at ucdavis.edu>
 #
 #  Distributed under the terms of the GNU General Public License (GPL)
@@ -16,7 +16,7 @@
 #  The full text of the GPL is available at:
 #
 #                  http://www.gnu.org/licenses/
-#****************************************************************************
+# ***************************************************************************
 
 from sage.structure.parent import Parent
 from sage.categories.infinite_enumerated_sets import InfiniteEnumeratedSets

src/sage/combinat/crystals/monomial_crystals.py

@@ -1,12 +1,6 @@
 # sage.doctest: needs sage.combinat sage.modules
 r"""
-Crystals of Modified Nakajima Monomials
-
-AUTHORS:
-
-- Arthur Lubovsky: Initial version
-
-- Ben Salisbury: Initial version
+Crystals of modified Nakajima monomials
 
 Let `Y_{i,k}`, for `i \in I` and `k \in \ZZ`, be a commuting set of
 variables, and let `\boldsymbol{1}` be a new variable which commutes with
@@ -74,6 +68,11 @@
     `C = (c_{ij})_{i\neq j}` satisfying the condition `c_{ij}+c_{ji}=1`.
     We have chosen such integers uniformly such that `c_{ij} = 1` if
     `i < j` and `c_{ij} = 0` if `i>j`.
+
+AUTHORS:
+
+- Arthur Lubovsky: initial version
+- Ben Salisbury: initial version
 """
 
 # *****************************************************************************

src/sage/combinat/crystals/multisegments.py

@@ -1,6 +1,6 @@
 # sage.doctest: needs sage.combinat sage.modules
 r"""
-Crystal of Bernstein-Zelevinsky Multisegments
+Crystal of Bernstein-Zelevinsky multisegments
 """
 
 #*****************************************************************************

src/sage/combinat/crystals/mv_polytopes.py

@@ -1,6 +1,6 @@
 # sage.doctest: needs sage.combinat sage.modules
 r"""
-Crystal Of Mirković-Vilonen (MV) Polytopes
+Crystal of Mirković-Vilonen polytopes
 
 AUTHORS:
 

src/sage/combinat/crystals/pbw_crystal.py

@@ -1,15 +1,15 @@
 # sage.doctest: needs sage.combinat sage.modules
 r"""
-`\mathcal{B}(\infty)` Crystal Of PBW Monomials
-
-AUTHORS:
-
-- Dinakar Muthiah (2015-05-11): initial version
+`\mathcal{B}(\infty)` crystal of PBW monomials
 
 .. SEEALSO::
 
     For information on PBW datum, see
     :ref:`sage.combinat.crystals.pbw_datum`.
+
+AUTHORS:
+
+- Dinakar Muthiah (2015-05-11): initial version
 """
 
 # ****************************************************************************

src/sage/combinat/crystals/pbw_datum.pyx

@@ -1,6 +1,6 @@
 # sage.doctest: needs sage.combinat sage.modules
 r"""
-PBW Data
+PBW data
 
 This contains helper classes and functions which encode PBW data
 in finite type.