More edits in index pages of combinatorics

Author: kwankyu

src/sage/categories/enumerated_sets.py

@@ -34,49 +34,49 @@ class EnumeratedSets(CategoryWithAxiom):
 
     The purpose of this category is threefold:
 
-     - to fix a common interface for all these sets;
-     - to provide a bunch of default implementations;
-     - to provide consistency tests.
+    - to fix a common interface for all these sets;
+    - to provide a bunch of default implementations;
+    - to provide consistency tests.
 
     The standard methods for an enumerated set ``S`` are:
 
-       - ``S.cardinality()`` -- the number of elements of the set. This
-         is the equivalent for ``len`` on a list except that the
-         return value is specified to be a Sage :class:`Integer` or
-         ``infinity``, instead of a Python ``int``.
+    - ``S.cardinality()`` -- the number of elements of the set. This
+      is the equivalent for ``len`` on a list except that the
+      return value is specified to be a Sage :class:`Integer` or
+      ``infinity``, instead of a Python ``int``.
 
-       - ``iter(S)`` -- an iterator for the elements of the set;
+    - ``iter(S)`` -- an iterator for the elements of the set;
 
-       - ``S.list()`` -- a fresh list of the elements of the set, when
-         possible; raises a :exc:`NotImplementedError` if the list is
-         predictably too large to be expanded in memory.
+    - ``S.list()`` -- a fresh list of the elements of the set, when
+      possible; raises a :exc:`NotImplementedError` if the list is
+      predictably too large to be expanded in memory.
 
-       - ``S.tuple()`` -- a tuple of the elements of the set, when
-         possible; raises a :exc:`NotImplementedError` if the tuple is
-         predictably too large to be expanded in memory.
+    - ``S.tuple()`` -- a tuple of the elements of the set, when
+      possible; raises a :exc:`NotImplementedError` if the tuple is
+      predictably too large to be expanded in memory.
 
-       - ``S.unrank(n)`` -- the  ``n``-th element of the set when ``n`` is a sage
-         ``Integer``. This is the equivalent for ``l[n]`` on a list.
+    - ``S.unrank(n)`` -- the  ``n``-th element of the set when ``n`` is a sage
+      ``Integer``. This is the equivalent for ``l[n]`` on a list.
 
-       - ``S.rank(e)`` -- the position of the element ``e`` in the set;
-         This is equivalent to ``l.index(e)`` for a list except that
-         the return value is specified to be a Sage :class:`Integer`,
-         instead of a Python ``int``.
+    - ``S.rank(e)`` -- the position of the element ``e`` in the set;
+      This is equivalent to ``l.index(e)`` for a list except that
+      the return value is specified to be a Sage :class:`Integer`,
+      instead of a Python ``int``.
 
-       - ``S.first()`` -- the first object of the set; it is equivalent to
-         ``S.unrank(0)``.
+    - ``S.first()`` -- the first object of the set; it is equivalent to
+      ``S.unrank(0)``.
 
-       - ``S.next(e)`` -- the object of the set which follows ``e``; it is
-         equivalent to ``S.unrank(S.rank(e) + 1)``.
+    - ``S.next(e)`` -- the object of the set which follows ``e``; it is
+      equivalent to ``S.unrank(S.rank(e) + 1)``.
 
-       - ``S.random_element()`` -- a random generator for an element of
-         the set. Unless otherwise stated, and for finite enumerated
-         sets, the probability is uniform.
+    - ``S.random_element()`` -- a random generator for an element of
+      the set. Unless otherwise stated, and for finite enumerated
+      sets, the probability is uniform.
 
     For examples and tests see:
 
-       - ``FiniteEnumeratedSets().example()``
-       - ``InfiniteEnumeratedSets().example()``
+    - ``FiniteEnumeratedSets().example()``
+    - ``InfiniteEnumeratedSets().example()``
 
     EXAMPLES::
 

src/sage/combinat/affine_permutation.py

@@ -1,6 +1,6 @@
 # sage.doctest: needs sage.combinat sage.groups
 r"""
-Affine Permutations
+Affine permutations
 """
 
 # ****************************************************************************

src/sage/combinat/combinat.py

@@ -464,7 +464,7 @@ def narayana_number(n: Integer, k: Integer) -> Integer:
 
     - ``n`` -- integer
 
-    - ``k`` -- integer between ``0`` and ``n - 1``
+    - ``k`` -- integer between `0` and `n - 1`
 
     OUTPUT: integer
 
@@ -762,8 +762,6 @@ def lucas_number2(n, P, Q):
     `L^{(2)}_2 = P` and the recurrence relation
     `L^{(2)}_{n+2} = P \cdot L^{(2)}_{n+1} - Q \cdot L^{(2)}_n`.
 
-    Wraps GAP's Lucas(...)[2].
-
     INPUT:
 
     - ``n`` -- integer
@@ -1683,10 +1681,10 @@ def _tuples_native(S, k):
 
 def number_of_tuples(S, k, algorithm='naive') -> Integer:
     """
-    Return the size of ``tuples(S, k)`` when `S` is a set. More
-    generally, return the size of ``tuples(set(S), k)``. (So,
-    unlike :meth:`tuples`, this method removes redundant entries from
-    `S`.)
+    Return the size of ``tuples(S, k)`` for a set `S`.
+
+    `S` is first converted to a set. Hence, unlike :meth:`tuples`, this method
+    removes redundant entries from `S`.
 
     INPUT:
 

src/sage/combinat/dlx.py

@@ -1,5 +1,5 @@
 """
-Exact Cover Problem via Dancing Links
+Exact cover problem via dancing links
 """
 # dlx.py
 # Copyright (c) 2006,2008 Antti Ajanki <[email protected]>

src/sage/combinat/dyck_word.py

@@ -1,5 +1,5 @@
 r"""
-Dyck Words
+Dyck words
 
 A class of an object enumerated by the
 :func:`Catalan numbers<sage.combinat.combinat.catalan_number>`,

src/sage/combinat/enumerated_sets.py

@@ -1,13 +1,6 @@
 """
 Enumerated sets and combinatorial objects
 
-.. TODO:: Proofread / point to the main classes rather than the modules
-
-Categories
-----------
-
-- :class:`EnumeratedSets`, :class:`FiniteEnumeratedSets`
-
 Basic enumerated sets
 ---------------------
 
@@ -46,8 +39,8 @@
 - :ref:`sage.combinat.debruijn_sequence`
 - :ref:`sage.combinat.shuffle`
 
-Permutations, ...
------------------
+Permutations and arrangements
+-----------------------------
 
 - :ref:`sage.combinat.permutation`
 - :ref:`sage.combinat.permutation_cython`
@@ -63,18 +56,13 @@
     - :ref:`sage.combinat.integer_vectors_mod_permgroup`
     - :ref:`sage.combinat.rsk`
 
-Partitions, tableaux, ...
--------------------------
-
-See: :ref:`sage.combinat.catalog_partitions`
-
 Polyominoes
 -----------
 
-See: :ref:`sage.combinat.parallelogram_polyomino`
+- :ref:`sage.combinat.parallelogram_polyomino`
 
-Integer matrices, ...
----------------------
+Integer matrices and arrays
+---------------------------
 
 - :ref:`sage.combinat.integer_matrices`
 - :ref:`sage.combinat.matrices.hadamard_matrix`
@@ -85,11 +73,6 @@
 - :ref:`sage.combinat.restricted_growth`
 - :ref:`sage.combinat.vector_partition`
 
-.. SEEALSO::
-
-    - :class:`MatrixSpace`
-    - :ref:`sage.groups.matrix_gps.catalog`
-
 Subsets and set partitions
 --------------------------
 
@@ -117,33 +100,24 @@
 - :ref:`sage.combinat.graph_path`
 - :ref:`sage.combinat.perfect_matching`
 
-Backtracking solvers and generic enumerated sets
-------------------------------------------------
+Miscellaneous enumerated sets
+-----------------------------
 
-.. TODO::
+- :class:`~sage.combinat.integer_lists.invlex.IntegerListsLex`
+- :class:`~sage.combinat.integer_vectors_mod_permgroup.IntegerVectorsModPermutationGroup`
+- :ref:`sage.combinat.gray_codes`
+- :class:`~sage.combinat.gelfand_tsetlin_patterns.GelfandTsetlinPattern`, :class:`~sage.combinat.gelfand_tsetlin_patterns.GelfandTsetlinPatterns`
+- :class:`~sage.combinat.knutson_tao_puzzles.KnutsonTaoPuzzleSolver`
+- :func:`LatticePolytope`
 
-    Do we want a separate section, possibly more proeminent, for
-    backtracking solvers?
+Backtracking solvers
+--------------------
 
 - :func:`~sage.sets.recursively_enumerated_set.RecursivelyEnumeratedSet`
 - :class:`~sage.combinat.backtrack.GenericBacktracker`
 - :mod:`sage.parallel.map_reduce`
 - :ref:`sage.combinat.tiling`
 - :ref:`sage.combinat.dlx`
 - :ref:`sage.combinat.matrices.dlxcpp`
-- :ref:`sage.combinat.species.all`
-- :class:`~sage.combinat.integer_lists.IntegerListsLex`
-- :class:`~sage.combinat.integer_vectors_mod_permgroup.IntegerVectorsModPermutationGroup`
-
-Low level enumerated sets
--------------------------
-
-- :ref:`sage.combinat.gray_codes`
-
-Misc enumerated sets
---------------------
 
-- :class:`~sage.combinat.gelfand_tsetlin_patterns.GelfandTsetlinPattern`, :class:`~sage.combinat.gelfand_tsetlin_patterns.GelfandTsetlinPatterns`
-- :class:`~sage.combinat.knutson_tao_puzzles.KnutsonTaoPuzzleSolver`
-- :func:`LatticePolytope`
 """

src/sage/combinat/parking_functions.py

@@ -1,5 +1,5 @@
 r"""
-Parking Functions
+Parking functions
 
 INFORMALLY (reference [Beck]_):
 

src/sage/combinat/ribbon_tableau.py

@@ -1,5 +1,5 @@
 r"""
-Ribbon Tableaux
+Ribbon tableaux
 """
 # ****************************************************************************
 #       Copyright (C) 2007 Mike Hansen <[email protected]>,

src/sage/combinat/skew_partition.py

@@ -1,5 +1,5 @@
 r"""
-Skew Partitions
+Skew partitions
 
 A skew partition ``skp`` of size `n` is a pair of
 partitions `[p_1, p_2]` where `p_1` is a

src/sage/combinat/skew_tableau.py

@@ -1,5 +1,5 @@
 r"""
-Skew Tableaux
+Skew tableaux
 
 AUTHORS:
 

src/sage/combinat/superpartition.py

@@ -1,9 +1,5 @@
 r"""
-Super Partitions
-
-AUTHORS:
-
-- Mike Zabrocki
+Super partitions
 
 A super partition of size `n` and fermionic sector `m` is a
 pair consisting of a strict partition of some integer `r` of
@@ -62,6 +58,10 @@
 REFERENCES:
 
 - [JL2016]_
+
+AUTHORS:
+
+- Mike Zabrocki
 """
 
 # ****************************************************************************

src/sage/combinat/tiling.py

@@ -1,8 +1,8 @@
 # sage.doctest: needs sage.combinat sage.modules
 r"""
-Tiling Solver
+Tiling solver
 
-Tiling a n-dimensional polyomino with n-dimensional polyominoes.
+Tiling a `n`-dimensional polyomino with n-dimensional polyominoes.
 
 This module defines two classes:
 

src/sage/combinat/words/all.py

@@ -15,13 +15,13 @@
 
 Main classes and functions meant to be used by the user:
 
-    :func:`~sage.combinat.words.word.Word`,
-    :class:`~sage.combinat.words.words.FiniteWords`,
-    :class:`~sage.combinat.words.words.InfiniteWords`,
-    :func:`~sage.combinat.words.words.Words`,
-    :func:`~sage.combinat.words.alphabet.Alphabet`,
-    :class:`~sage.combinat.words.morphism.WordMorphism`,
-    :class:`~sage.combinat.words.paths.WordPaths`.
+:func:`~sage.combinat.words.word.Word`,
+:class:`~sage.combinat.words.words.FiniteWords`,
+:class:`~sage.combinat.words.words.InfiniteWords`,
+:func:`~sage.combinat.words.words.Words`,
+:func:`~sage.combinat.words.alphabet.Alphabet`,
+:class:`~sage.combinat.words.morphism.WordMorphism`,
+:class:`~sage.combinat.words.paths.WordPaths`.
 
 A list of common words can be accessed through ``words.<tab>`` and are listed in
 the :ref:`words catalog <sage.combinat.words.word_generators>`.

src/sage/combinat/words/suffix_trees.py

@@ -1,5 +1,5 @@
 r"""
-Suffix Tries and Suffix Trees
+Suffix tries and Suffix trees
 """
 # ****************************************************************************
 #       Copyright (C) 2008 Franco Saliola <[email protected]>