Skip to content

Commit 537dfc7

Browse files
doc: some fixes
1 parent b4aae24 commit 537dfc7

5 files changed

Lines changed: 31 additions & 23 deletions

File tree

src/bmat8.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -278,7 +278,7 @@ Returns the identity :any:`BMat8` of a given dimension.
278278
This function returns the :any:`BMat8` with the first *dim* entries in the
279279
main diagonal equal to ``1`` and every other value equal to ``0``.
280280
281-
:param dim: the dimension of the identity (default: 8)
281+
:param dim: the dimension of the identity (default: ``8``)
282282
:type dim: int
283283
284284
:returns: A :any:`BMat8`.

src/knuth-bendix-impl.cpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ Return the number of pending rules that must accumulate before they are reduced,
125125
processed, and added to the system.
126126
127127
The default value is ``128``. A value of ``1`` means :any:`Runner.run` should
128-
attempt to add each rule as they are created without waiting for rules to
128+
attempt to add each rule as it is created without waiting for rules to
129129
accumulate.
130130
131131
:return: The batch size.
@@ -145,7 +145,7 @@ Specify the number of pending rules that must accumulate before they are
145145
reduced, processed, and added to the system.
146146
147147
The default value is ``128``, and should be set to ``1`` if :any:`Runner.run`
148-
should attempt to add each rule as they are created without waiting for rules
148+
should attempt to add each rule as it is created without waiting for rules
149149
to accumulate.
150150
151151
:param val: The new value of the batch size.

src/runner.cpp

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -303,7 +303,8 @@ has been called since construction or the last call to :any:`init`.
303303
R"pbdoc(
304304
Initialize an existing Runner object.
305305
306-
This function puts a :any:`Runner` object back into the same state as if it had been newly default constructed.
306+
This function puts a :any:`Runner` object back into the same state as if it had
307+
been newly default constructed.
307308
308309
:returns: ``self``.
309310
:rtype: Runner

src/todd-coxeter-impl.cpp

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -456,7 +456,7 @@ phase of the `ACE <https://staff.itee.uq.edu.au/havas/>`_ style
456456
If the strategy is not one of those listed above, then this setting is
457457
ignored.
458458
459-
The default value of this setting is ``100000``.
459+
The default value of this setting is ``10 ** 5``.
460460
461461
:returns:
462462
The current value of the setting.
@@ -488,15 +488,15 @@ style strategies:
488488
If the strategy is not one of those listed above, then this setting is
489489
ignored.
490490
491-
The default value of this setting is ``100'000``.
491+
The default value of this setting is ``10 ** 5``.
492492
493493
:param val: the value to use.
494494
:type val: int
495495
496496
:returns: ``self``.
497497
:rtype: ToddCoxeter
498498
499-
:raises LibsemigroupsError: if ``val`` is ``0``.
499+
:raises LibsemigroupsError: if *val* is ``0``.
500500
)pbdoc");
501501

502502
thing.def(
@@ -518,7 +518,7 @@ the `ACE <https://staff.itee.uq.edu.au/havas/>`_ style strategies:
518518
If the strategy is not one of those listed above, then this setting is
519519
ignored.
520520
521-
The default value of this setting is ``100000``.
521+
The default value of this setting is ``10 ** 5``.
522522
523523
:returns:
524524
The current value of the setting.
@@ -549,15 +549,15 @@ style strategies:
549549
550550
If the strategy is not one of those listed above, then this setting is ignored.
551551
552-
The default value of this setting is ``200000``.
552+
The default value of this setting is ``2 * 10 ** 5``.
553553
554554
:param val: the value to use.
555555
:type val: int
556556
557557
:returns: ``self``.
558558
:rtype: ToddCoxeter
559559
560-
:raises LibsemigroupsError: if ``val`` is ``0``.
560+
:raises LibsemigroupsError: if *val* is ``0``.
561561
562562
)pbdoc");
563563

@@ -571,7 +571,7 @@ Get the current size of a large collapse. This function can be used to
571571
get what is currently considered a "large" collapse. See
572572
:any:`large_collapse` for the meaning of this setting.
573573
574-
The default value of this setting is ``100'000``.
574+
The default value of this setting is ``10 ** 5``.
575575
576576
:returns:
577577
The current value of the setting.
@@ -686,7 +686,7 @@ a lookahead grows. More specifically, at the end of any lookahead if the number
686686
of active nodes already exceeds the value of :any:`lookahead_next` or the
687687
number of nodes killed during the lookahead is less than the number of active
688688
nodes divided by :any:`lookahead_growth_threshold`, then the value of
689-
:any:`lookahead_next` is increased by a multiple of ``val``. The default value
689+
:any:`lookahead_next` is increased by a multiple of *val*. The default value
690690
is of this setting is ``2.0``.
691691
692692
:param val: the value indicating the lookahead growth factor.
@@ -695,7 +695,7 @@ is of this setting is ``2.0``.
695695
:returns: ``self``.
696696
:rtype: ToddCoxeter
697697
698-
:raises LibsemigroupsError: if ``val`` is less than ``1.0``.
698+
:raises LibsemigroupsError: if *val* is less than ``1.0``.
699699
)pbdoc");
700700
thing.def(
701701
"lookahead_growth_threshold",
@@ -747,7 +747,7 @@ active nodes divided by :any:`lookahead_growth_threshold`, then the value of
747747
Get the current value of the minimum lookahead setting. This function
748748
returns the current value of the minimum lookahead. See
749749
:any:`lookahead_min` for a full description of this setting. The
750-
default value is ``10000``.
750+
default value is ``10 ** 4``.
751751
752752
:returns:
753753
The current value of the minimum lookahead.
@@ -770,7 +770,7 @@ depending on the outcome of the current lookahead. If the return value of
770770
:any:`lookahead_next` is too small or too large, then the value is adjusted
771771
according to :any:`lookahead_growth_factor` and
772772
:any:`lookahead_growth_threshold`. This setting specified the minimum possible
773-
value for :any:`lookahead_next()`. The default value is ``10000``.
773+
value for :any:`lookahead_next()`. The default value is ``10 ** 4``.
774774
775775
:param val: value indicating the minimum value of lookahead_next.
776776
:type val: int
@@ -807,8 +807,8 @@ Set the threshold that will trigger a lookahead.
807807
808808
If the number of active nodes exceeds the value set by this function, then a
809809
lookahead of style :any:`ToddCoxeter.lookahead_style` and extent
810-
:any:`ToddCoxeter.lookahead_extent` will be triggered. The default value is 5
811-
million.
810+
:any:`ToddCoxeter.lookahead_extent` will be triggered. The default value is
811+
``5 * 10 ** 6``.
812812
813813
:param val: value indicating the initial threshold.
814814
:type val: int
@@ -909,7 +909,7 @@ result in many nodes being killed).
909909
:rtype: ToddCoxeter
910910
911911
:raises LibsemigroupsError:
912-
if ``val`` is not in the interval :math:`[0, 1)`.
912+
if *val* is not in the interval :math:`[0, 1)`.
913913
)pbdoc");
914914
thing.def(
915915
"lookahead_style",
@@ -1199,12 +1199,14 @@ has been standardized with respect to the any :any:`Order` other than
11991199
Check if the word graph is currently standardized with respect to a given order.
12001200
12011201
This function returns ``True`` if the :any:`current_word_graph` has been
1202-
standardized with respect to the order ``val`` ; and ``False`` if not.
1202+
standardized with respect to the order *val* ; and ``False`` if not.
12031203
12041204
:param val: the Order to check for.
12051205
:type val: Order
12061206
1207-
:returns: Whether or not the current word graph is standardized with respect to a given order.
1207+
:returns:
1208+
Whether or not the current word graph is standardized with respect to
1209+
a given order.
12081210
:rtype: bool
12091211
)pbdoc");
12101212

src/ukkonen.cpp

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -654,13 +654,18 @@ The index of one past the last letter in the edge leading to the node.
654654
R"pbdoc(
655655
Construct a node from left most index, right most index, and parent.
656656
657-
:param l: the left most index and value of the data member l (defaults to ``0``).
657+
:param l:
658+
the left most index and value of the data member *l* (defaults to ``0``).
658659
:type l: int
659660
660-
:param r: one after the right most index and value of the data member r (defaults to ``0``).
661+
:param r:
662+
one after the right most index and value of the data member *r*
663+
(defaults to ``0``).
661664
:type r: int
662665
663-
:param parent: parent of the node being constructed (defaults to :any:`UNDEFINED`).
666+
:param parent:
667+
parent of the node being constructed (defaults to
668+
:any:`UNDEFINED`).
664669
:type parent: int
665670
)pbdoc");
666671
node.def("__copy__",

0 commit comments

Comments
 (0)