From 7fb9575e8e2c172a9c7de85d21f1ebd7c3170e64 Mon Sep 17 00:00:00 2001 From: James Mitchell Date: Wed, 11 Jun 2025 16:18:34 +0100 Subject: [PATCH] doc: some fixes --- src/bmat8.cpp | 2 +- src/knuth-bendix-impl.cpp | 4 ++-- src/runner.cpp | 3 ++- src/todd-coxeter-impl.cpp | 34 ++++++++++++++++++---------------- src/ukkonen.cpp | 11 ++++++++--- 5 files changed, 31 insertions(+), 23 deletions(-) diff --git a/src/bmat8.cpp b/src/bmat8.cpp index 8103b3b6d..dce17affb 100644 --- a/src/bmat8.cpp +++ b/src/bmat8.cpp @@ -278,7 +278,7 @@ Returns the identity :any:`BMat8` of a given dimension. This function returns the :any:`BMat8` with the first *dim* entries in the main diagonal equal to ``1`` and every other value equal to ``0``. -:param dim: the dimension of the identity (default: 8) +:param dim: the dimension of the identity (default: ``8``) :type dim: int :returns: A :any:`BMat8`. diff --git a/src/knuth-bendix-impl.cpp b/src/knuth-bendix-impl.cpp index f4309b59f..e24d45320 100644 --- a/src/knuth-bendix-impl.cpp +++ b/src/knuth-bendix-impl.cpp @@ -125,7 +125,7 @@ Return the number of pending rules that must accumulate before they are reduced, processed, and added to the system. The default value is ``128``. A value of ``1`` means :any:`Runner.run` should -attempt to add each rule as they are created without waiting for rules to +attempt to add each rule as it is created without waiting for rules to accumulate. :return: The batch size. @@ -145,7 +145,7 @@ Specify the number of pending rules that must accumulate before they are reduced, processed, and added to the system. The default value is ``128``, and should be set to ``1`` if :any:`Runner.run` -should attempt to add each rule as they are created without waiting for rules +should attempt to add each rule as it is created without waiting for rules to accumulate. :param val: The new value of the batch size. diff --git a/src/runner.cpp b/src/runner.cpp index a35fb084f..933344372 100644 --- a/src/runner.cpp +++ b/src/runner.cpp @@ -301,7 +301,8 @@ has been called since construction or the last call to :any:`init`. R"pbdoc( Initialize an existing Runner object. -This function puts a :any:`Runner` object back into the same state as if it had been newly default constructed. +This function puts a :any:`Runner` object back into the same state as if it had +been newly default constructed. :returns: ``self``. :rtype: Runner diff --git a/src/todd-coxeter-impl.cpp b/src/todd-coxeter-impl.cpp index d9c0af2ac..d5d46ca25 100644 --- a/src/todd-coxeter-impl.cpp +++ b/src/todd-coxeter-impl.cpp @@ -456,7 +456,7 @@ phase of the `ACE `_ style If the strategy is not one of those listed above, then this setting is ignored. -The default value of this setting is ``100000``. +The default value of this setting is ``10 ** 5``. :returns: The current value of the setting. @@ -488,7 +488,7 @@ style strategies: If the strategy is not one of those listed above, then this setting is ignored. -The default value of this setting is ``100'000``. +The default value of this setting is ``10 ** 5``. :param val: the value to use. :type val: int @@ -496,7 +496,7 @@ The default value of this setting is ``100'000``. :returns: ``self``. :rtype: ToddCoxeter -:raises LibsemigroupsError: if ``val`` is ``0``. +:raises LibsemigroupsError: if *val* is ``0``. )pbdoc"); thing.def( @@ -518,7 +518,7 @@ the `ACE `_ style strategies: If the strategy is not one of those listed above, then this setting is ignored. -The default value of this setting is ``100000``. +The default value of this setting is ``10 ** 5``. :returns: The current value of the setting. @@ -549,7 +549,7 @@ style strategies: If the strategy is not one of those listed above, then this setting is ignored. -The default value of this setting is ``200000``. +The default value of this setting is ``2 * 10 ** 5``. :param val: the value to use. :type val: int @@ -557,7 +557,7 @@ The default value of this setting is ``200000``. :returns: ``self``. :rtype: ToddCoxeter -:raises LibsemigroupsError: if ``val`` is ``0``. +:raises LibsemigroupsError: if *val* is ``0``. )pbdoc"); @@ -571,7 +571,7 @@ Get the current size of a large collapse. This function can be used to get what is currently considered a "large" collapse. See :any:`large_collapse` for the meaning of this setting. -The default value of this setting is ``100'000``. +The default value of this setting is ``10 ** 5``. :returns: The current value of the setting. @@ -686,7 +686,7 @@ a lookahead grows. More specifically, at the end of any lookahead if the number of active nodes already exceeds the value of :any:`lookahead_next` or the number of nodes killed during the lookahead is less than the number of active nodes divided by :any:`lookahead_growth_threshold`, then the value of -:any:`lookahead_next` is increased by a multiple of ``val``. The default value +:any:`lookahead_next` is increased by a multiple of *val*. The default value is of this setting is ``2.0``. :param val: the value indicating the lookahead growth factor. @@ -695,7 +695,7 @@ is of this setting is ``2.0``. :returns: ``self``. :rtype: ToddCoxeter -:raises LibsemigroupsError: if ``val`` is less than ``1.0``. +:raises LibsemigroupsError: if *val* is less than ``1.0``. )pbdoc"); thing.def( "lookahead_growth_threshold", @@ -747,7 +747,7 @@ active nodes divided by :any:`lookahead_growth_threshold`, then the value of Get the current value of the minimum lookahead setting. This function returns the current value of the minimum lookahead. See :any:`lookahead_min` for a full description of this setting. The -default value is ``10000``. +default value is ``10 ** 4``. :returns: The current value of the minimum lookahead. @@ -770,7 +770,7 @@ depending on the outcome of the current lookahead. If the return value of :any:`lookahead_next` is too small or too large, then the value is adjusted according to :any:`lookahead_growth_factor` and :any:`lookahead_growth_threshold`. This setting specified the minimum possible -value for :any:`lookahead_next()`. The default value is ``10000``. +value for :any:`lookahead_next()`. The default value is ``10 ** 4``. :param val: value indicating the minimum value of lookahead_next. :type val: int @@ -807,8 +807,8 @@ Set the threshold that will trigger a lookahead. If the number of active nodes exceeds the value set by this function, then a lookahead of style :any:`ToddCoxeter.lookahead_style` and extent -:any:`ToddCoxeter.lookahead_extent` will be triggered. The default value is 5 -million. +:any:`ToddCoxeter.lookahead_extent` will be triggered. The default value is +``5 * 10 ** 6``. :param val: value indicating the initial threshold. :type val: int @@ -909,7 +909,7 @@ result in many nodes being killed). :rtype: ToddCoxeter :raises LibsemigroupsError: - if ``val`` is not in the interval :math:`[0, 1)`. + if *val* is not in the interval :math:`[0, 1)`. )pbdoc"); thing.def( "lookahead_style", @@ -1199,12 +1199,14 @@ has been standardized with respect to the any :any:`Order` other than Check if the word graph is currently standardized with respect to a given order. This function returns ``True`` if the :any:`current_word_graph` has been -standardized with respect to the order ``val`` ; and ``False`` if not. +standardized with respect to the order *val* ; and ``False`` if not. :param val: the Order to check for. :type val: Order -:returns: Whether or not the current word graph is standardized with respect to a given order. +:returns: + Whether or not the current word graph is standardized with respect to + a given order. :rtype: bool )pbdoc"); diff --git a/src/ukkonen.cpp b/src/ukkonen.cpp index b97d809cc..1412e6c6e 100644 --- a/src/ukkonen.cpp +++ b/src/ukkonen.cpp @@ -653,13 +653,18 @@ The index of one past the last letter in the edge leading to the node. R"pbdoc( Construct a node from left most index, right most index, and parent. -:param l: the left most index and value of the data member l (defaults to ``0``). +:param l: + the left most index and value of the data member *l* (defaults to ``0``). :type l: int -:param r: one after the right most index and value of the data member r (defaults to ``0``). +:param r: + one after the right most index and value of the data member *r* + (defaults to ``0``). :type r: int -:param parent: parent of the node being constructed (defaults to :any:`UNDEFINED`). +:param parent: + parent of the node being constructed (defaults to + :any:`UNDEFINED`). :type parent: int )pbdoc"); node.def("__copy__",