Add more missing functions to summary

Joseph-Edwards · Joseph-Edwards · commit f6907077d2c7 · 2025-06-11T17:30:43.000+01:00
Add missing Action functions to summary

Add missing Congruence functions to summary

Add missing FroidurePin functions to summary

Add missing Kambites functions to summary

Add missing KnuthBendix functions to summary

Add missing Konieczny functions to summary

Add missing Sims functions to summary

Add missing SchreierSims functions to summary

Add missing Stephen functions to summary

Add missing ToddCoxeter functions to summary
diff --git a/docs/source/main-algorithms/action/action.rst b/docs/source/main-algorithms/action/action.rst
@@ -23,12 +23,16 @@ Contents
     ~Action
     Action.add_generator
     Action.add_seed
+    Action.apply
     Action.cache_scc_multipliers
+    Action.copy
     Action.current_size
     Action.empty
+    Action.generators
     Action.init
     Action.multiplier_from_scc_root
     Action.multiplier_to_scc_root
+    Action.number_of_generators
     Action.position
     Action.reserve
     Action.root_of_scc
diff --git a/docs/source/main-algorithms/action/index.rst b/docs/source/main-algorithms/action/index.rst
@@ -17,6 +17,6 @@ This page contains links to the documentation for the classes in
     :maxdepth: 1
 
     action
-    rightaction
     leftaction
+    rightaction
     side
diff --git a/docs/source/main-algorithms/congruence/class.rst b/docs/source/main-algorithms/congruence/class.rst
@@ -29,10 +29,14 @@ Contents
     Congruence.get
     Congruence.has
     Congruence.init
+    Congruence.kind
     Congruence.max_threads
     Congruence.number_of_classes
+    Congruence.number_of_generating_pairs
     Congruence.number_of_runners
     Congruence.presentation
+    Congruence.reduce
+    Congruence.reduce_no_run
 
 Full API
 --------
diff --git a/docs/source/main-algorithms/congruence/helpers.rst b/docs/source/main-algorithms/congruence/helpers.rst
@@ -5,8 +5,8 @@
 
     The full license is in the file LICENSE, distributed with this software.
 
-Congruence helper functions
-===========================
+Congruence helpers
+==================
 
 This page contains the documentation for various helper functions for
 manipulating :any:`Congruence` objects.
diff --git a/docs/source/main-algorithms/froidure-pin/class.rst b/docs/source/main-algorithms/froidure-pin/class.rst
@@ -20,6 +20,7 @@ Contents
 .. autosummary::
     :signatures: short
 
+    ~FroidurePin
     FroidurePin.add_generator
     FroidurePin.add_generators
     FroidurePin.batch_size
@@ -29,6 +30,7 @@ Contents
     FroidurePin.copy
     FroidurePin.copy_add_generators
     FroidurePin.copy_closure
+    FroidurePin.current_elements
     FroidurePin.current_left_cayley_graph
     FroidurePin.current_length
     FroidurePin.current_max_word_length
@@ -54,6 +56,7 @@ Contents
     FroidurePin.number_of_idempotents
     FroidurePin.number_of_rules
     FroidurePin.position
+    FroidurePin.position_of_generator
     FroidurePin.prefix
     FroidurePin.reserve
     FroidurePin.right_cayley_graph
diff --git a/docs/source/main-algorithms/froidure-pin/helpers.rst b/docs/source/main-algorithms/froidure-pin/helpers.rst
@@ -1,5 +1,5 @@
-Helper functions for FroidurePin objects
-========================================
+FroidurePin helpers
+===================
 
 This page contains the documentation for various helper functions for
 manipulating :any:`FroidurePin` objects.
@@ -12,9 +12,9 @@ Contents
 .. autosummary::
     :signatures: short
 
-    current_position
     current_minimal_factorisation
     current_normal_forms
+    current_position
     current_rules
     equal_to
     factorisation
diff --git a/docs/source/main-algorithms/kambites/helpers.rst b/docs/source/main-algorithms/kambites/helpers.rst
@@ -7,8 +7,8 @@
 
 .. currentmodule:: libsemigroups_pybind11.kambites
 
-Kambites helper functions
-=========================
+Kambites helpers
+================
 
 This page contains the documentation for various helper functions for
 manipulating :any:`Kambites` objects.
@@ -19,8 +19,8 @@ Contents
 .. autosummary::
     :signatures: short
 
-    normal_forms
     non_trivial_classes
+    normal_forms
     partition
 
 Full API
diff --git a/docs/source/main-algorithms/knuth-bendix/class/index.rst b/docs/source/main-algorithms/knuth-bendix/class/index.rst
@@ -27,6 +27,7 @@ Contents
 
     ~KnuthBendix
     KnuthBendix.active_rules
+    KnuthBendix.add_generating_pair
     KnuthBendix.check_confluence_interval
     KnuthBendix.confluent
     KnuthBendix.confluent_known
@@ -36,11 +37,14 @@ Contents
     KnuthBendix.generating_pairs
     KnuthBendix.gilman_graph
     KnuthBendix.gilman_graph_node_labels
+    KnuthBendix.init
+    KnuthBendix.kind
     KnuthBendix.max_overlap
     KnuthBendix.max_pending_rules
     KnuthBendix.max_rules
     KnuthBendix.number_of_active_rules
     KnuthBendix.number_of_classes
+    KnuthBendix.number_of_generating_pairs
     KnuthBendix.number_of_inactive_rules
     KnuthBendix.overlap_policy
     KnuthBendix.presentation
@@ -57,7 +61,7 @@ Full API
     :inherited-members:
     :exclude-members: 
         options, run_for, run_until, run, finished, stopped, current_state, dead,
-        internal_generating_pairs, kill, kind, last_report, report, report_every,
+        internal_generating_pairs, kill, last_report, report, report_every,
         report_prefix, report_why_we_stopped, reset_last_report, reset_start_time,
         running, running_for, running_until, start_time, started, state,
         stopped_by_predicate, success, timed_out
diff --git a/docs/source/main-algorithms/knuth-bendix/helpers.rst b/docs/source/main-algorithms/knuth-bendix/helpers.rst
@@ -5,8 +5,8 @@
 
     The full license is in the file LICENSE, distributed with this software.
 
-Knuth-Bendix helpers
-====================
+KnuthBendix helpers
+===================
 
 This page contains the documentation for various helper functions for
 manipulating :any:`KnuthBendix` objects. All such functions are contained in the
diff --git a/docs/source/main-algorithms/low-index/classes/minimalreporc.rst b/docs/source/main-algorithms/low-index/classes/minimalreporc.rst
@@ -21,7 +21,6 @@ Contents
     :signatures: short
 
     ~MinimalRepOrc
-    MinimalRepOrc.__init__
     MinimalRepOrc.add_excluded_pair
     MinimalRepOrc.add_included_pair
     MinimalRepOrc.add_pruner
@@ -41,13 +40,13 @@ Contents
     MinimalRepOrc.presentation
     MinimalRepOrc.pruners
     MinimalRepOrc.stats
+    MinimalRepOrc.target_size
+    MinimalRepOrc.word_graph
 
 Full API
 --------
 
 .. autoclass:: MinimalRepOrc
-    :no-doc:
-    :class-doc-from: class
+    :class-doc-from: init
     :members:
     :inherited-members:
-    :special-members: __init__
diff --git a/docs/source/main-algorithms/low-index/classes/reporc.rst b/docs/source/main-algorithms/low-index/classes/reporc.rst
@@ -21,7 +21,6 @@ Contents
     :signatures: short
 
     ~RepOrc
-    RepOrc.__init__
     RepOrc.add_excluded_pair
     RepOrc.add_included_pair
     RepOrc.add_pruner
@@ -36,18 +35,20 @@ Contents
     RepOrc.init
     RepOrc.long_rule_length
     RepOrc.long_rules
+    RepOrc.max_nodes
+    RepOrc.min_nodes
     RepOrc.number_of_long_rules
     RepOrc.number_of_threads
     RepOrc.presentation
     RepOrc.pruners
     RepOrc.stats
+    RepOrc.target_size
+    RepOrc.word_graph
 
 Full API
 --------
 
 .. autoclass:: RepOrc
-    :no-doc:
-    :class-doc-from: class
+    :class-doc-from: init
     :members:
     :inherited-members:
-    :special-members: __init__
diff --git a/docs/source/main-algorithms/low-index/classes/sims1.rst b/docs/source/main-algorithms/low-index/classes/sims1.rst
@@ -49,10 +49,6 @@ Contents
 Full API
 --------
 
-..
-    TODO(0) document __init__ directly, the same trick that works for RepOrc +
-    MinimalRepOrc doesn't work here for some reason.
-
 .. autoclass:: Sims1
     :class-doc-from: init
     :members:
diff --git a/docs/source/main-algorithms/low-index/classes/sims2.rst b/docs/source/main-algorithms/low-index/classes/sims2.rst
@@ -49,10 +49,6 @@ Contents
 Full API
 --------
 
-..
-    TODO(0) document __init__ directly, the same trick that works for RepOrc +
-    MinimalRepOrc doesn't work here for some reason.
-
 .. autoclass:: Sims2
     :class-doc-from: init
     :members:
diff --git a/docs/source/main-algorithms/low-index/classes/simsrefinerfaithful.rst b/docs/source/main-algorithms/low-index/classes/simsrefinerfaithful.rst
@@ -21,7 +21,6 @@ Contents
     :signatures: short
 
     ~SimsRefinerFaithful
-    SimsRefinerFaithful.__init__
     SimsRefinerFaithful.__call__
     SimsRefinerFaithful.forbid
     SimsRefinerFaithful.init
@@ -30,8 +29,7 @@ Full API
 --------
 
 .. autoclass:: SimsRefinerFaithful
-    :no-doc:
-    :class-doc-from: class
+    :class-doc-from: init
     :members:
     :inherited-members:
-    :special-members: __call__, __init__
+    :special-members: __call__
diff --git a/docs/source/main-algorithms/low-index/classes/simsrefinerideals.rst b/docs/source/main-algorithms/low-index/classes/simsrefinerideals.rst
@@ -22,16 +22,14 @@ Contents
 
     ~SimsRefinerIdeals
     SimsRefinerIdeals.__call__
-    SimsRefinerIdeals.__init__
     SimsRefinerIdeals.init
     SimsRefinerIdeals.presentation
 
 Full API
 --------
 
 .. autoclass:: SimsRefinerIdeals
-    :no-doc:
-    :class-doc-from: class
+    :class-doc-from: init
     :members:
     :inherited-members:
-    :special-members: __call__, __init__
+    :special-members: __call__
diff --git a/docs/source/main-algorithms/low-index/classes/simsstats.rst b/docs/source/main-algorithms/low-index/classes/simsstats.rst
@@ -21,6 +21,15 @@ Contents
     :signatures: short
 
     ~SimsStats
+    SimsStats.copy
+    SimsStats.count_last
+    SimsStats.count_now
+    SimsStats.init
+    SimsStats.max_pending
+    SimsStats.stats_check_point
+    SimsStats.stats_zero
+    SimsStats.total_pending_last
+    SimsStats.total_pending_now
 
 Full API
 --------
diff --git a/docs/source/main-algorithms/schreier-sims/class.rst b/docs/source/main-algorithms/schreier-sims/class.rst
@@ -20,11 +20,13 @@ Contents
 .. autosummary::
     :signatures: short
 
+    ~SchreierSims
     SchreierSims.add_base_point
     SchreierSims.add_generator
     SchreierSims.base
     SchreierSims.base_size
     SchreierSims.contains
+    SchreierSims.copy
     SchreierSims.current_size
     SchreierSims.currently_contains
     SchreierSims.empty
diff --git a/docs/source/main-algorithms/schreier-sims/helpers.rst b/docs/source/main-algorithms/schreier-sims/helpers.rst
@@ -5,17 +5,15 @@
 
     The full license is in the file LICENSE, distributed with this software.
 
-Schreier-Sims helper functions
-==============================
+SchreierSims helpers
+====================
 
 This page contains the documentation for various helper functions for
 manipulating :any:`SchreierSims` objects.
 
 Contents
 --------
 
-In ``libsemigroups_pybind11``:
-
 .. currentmodule:: libsemigroups_pybind11.schreier_sims
 
 .. autosummary::
diff --git a/docs/source/main-algorithms/stephen/class.rst b/docs/source/main-algorithms/stephen/class.rst
@@ -22,13 +22,14 @@ Contents
 
     ~Stephen
     Stephen.accept_state
+    Stephen.copy
     Stephen.init
+    Stephen.initial_state
     Stephen.is_word_set
     Stephen.presentation
     Stephen.set_word
     Stephen.word
     Stephen.word_graph
-    Stephen.initial_state
 
 Full API
 --------
diff --git a/docs/source/main-algorithms/stephen/helpers.rst b/docs/source/main-algorithms/stephen/helpers.rst
@@ -5,8 +5,8 @@
 
     The full license is in the file LICENSE, distributed with this software.
 
-Stephen helper functions
-========================
+Stephen helpers
+===============
 
 This page contains the documentation for various helper functions for
 manipulating :any:`Stephen` objects.
diff --git a/docs/source/main-algorithms/todd-coxeter/helpers.rst b/docs/source/main-algorithms/todd-coxeter/helpers.rst
@@ -5,8 +5,8 @@
 
     The full license is in the file LICENSE, distributed with this software.
 
-Todd-Coxeter helper functions
-=============================
+ToddCoxeter helpers
+===================
 
 This page contains the documentation for various helper functions for
 manipulating :any:`ToddCoxeter` objects.
@@ -21,9 +21,9 @@ Contents
 
     class_by_index
     class_of
-    normal_forms
     is_non_trivial
     non_trivial_classes
+    normal_forms
     partition
     redundant_rule
 
diff --git a/src/libsemigroups_pybind11/congruence.py b/src/libsemigroups_pybind11/congruence.py
@@ -12,7 +12,7 @@
 the submodule ``congruence``.
 """
 
-from typing import Union
+from typing import Union as _Union
 from typing_extensions import Self as _Self
 
 from _libsemigroups_pybind11 import (  # pylint: disable=no-name-in-module
@@ -73,7 +73,7 @@ def __init__(self: _Self, *args, **kwargs) -> None:
 
     def get(
         self: _Self, t: type
-    ) -> Union[_Kambites, _KnuthBendix, _ToddCoxeter]:
+    ) -> _Union[_Kambites, _KnuthBendix, _ToddCoxeter]:
         """
         :sig=(self: Congruence, t: type) -> Kambites | KnuthBendix | ToddCoxeter:
         Returns the *t* instance used to compute the congruence (if any).
diff --git a/src/libsemigroups_pybind11/froidure_pin.py b/src/libsemigroups_pybind11/froidure_pin.py
diff --git a/src/libsemigroups_pybind11/kambites.py b/src/libsemigroups_pybind11/kambites.py
diff --git a/src/libsemigroups_pybind11/konieczny.py b/src/libsemigroups_pybind11/konieczny.py
diff --git a/src/libsemigroups_pybind11/todd_coxeter.py b/src/libsemigroups_pybind11/todd_coxeter.py
