Skip to content

Commit fcc97b6

Browse files
doc: fixes from code review
1 parent 1e40a1c commit fcc97b6

5 files changed

Lines changed: 19 additions & 19 deletions

File tree

src/cong-common.cpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,7 @@ of kind *knd* over the semigroup or monoid defined by the presentation *p*.
227227
228228
{detail}
229229
230-
:param knd: the kind (onesided or twosided) of the congruence.
230+
:param knd: the kind (`onesided` or `twosided`) of the congruence.
231231
:type knd: congruence_kind
232232
233233
:param p: the presentation.
@@ -307,7 +307,7 @@ had been newly constructed from *knd* and *p*.
307307
308308
{detail}
309309
310-
:param knd: the kind (onesided or twosided) of the congruence.
310+
:param knd: the kind (`onesided` or `twosided`) of the congruence.
311311
:type knd: :any:`congruence_kind`
312312
313313
:param p: the presentation.

src/sims.cpp

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1851,7 +1851,6 @@ congruence lattice of the semigroup or monoid.
18511851
:param sims: a :any:`Sims1` object.
18521852
:type sims: Sims1
18531853
1854-
:param n: maximum number of congruence classes.
18551854
:param n: the maximum number of congruence classes.
18561855
:type n: int
18571856

src/todd-coxeter-impl.cpp

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -289,7 +289,7 @@ congruence of kind *knd* over the :any:`ToddCoxeter` instance *tc*. The
289289
:any:`ToddCoxeter` instance constructed in this way represents a quotient of
290290
the word graph represented by *tc*.
291291
292-
:param knd: the kind (one-sided or two-sided) of the congruence.
292+
:param knd: the kind (`onesided` or `twosided`) of the congruence.
293293
:type knd: congruence_kind
294294
295295
:param tc: the :any:`ToddCoxeter` instance.
@@ -298,8 +298,8 @@ the word graph represented by *tc*.
298298
:raises LibsemigroupsError:
299299
if the arguments *knd* and *tc* are not compatible. If the first item is
300300
``tc.kind()`` and the second is the parameter *knd*, then compatible
301-
arguments are (one-sided, one-sided), (two-sided, one-sided), and (two-sided,
302-
two-sided).
301+
arguments are (`onesided`, `onesided`), (`twosided`, `onesided`), and (`twosided`,
302+
`twosided`).
303303
)pbdoc");
304304

305305
thing.def(py::init<congruence_kind, WordGraph<uint32_t> const&>(),
@@ -319,7 +319,7 @@ or right Cayley graph of a semigroup or monoid, then the
319319
:any:`ToddCoxeter` instance will represent a quotient of that
320320
semigroup.
321321
322-
:param knd: the kind (one-sided or two-sided) of the congruence.
322+
:param knd: the kind (`onesided` or `twosided`) of the congruence.
323323
:type knd: congruence_kind
324324
325325
:param wg: the word graph.
@@ -345,7 +345,7 @@ This function puts a :any:`ToddCoxeter` instance back into the state
345345
that it would have been in if it had just been newly constructed from
346346
*knd* and *tc*.
347347
348-
:param knd: the kind (one-sided or two-sided) of the congruence.
348+
:param knd: the kind (`onesided` or `twosided`) of the congruence.
349349
:type knd: congruence_kind
350350
351351
:param tc: the :any:`ToddCoxeter` instance.
@@ -357,8 +357,8 @@ that it would have been in if it had just been newly constructed from
357357
:raises LibsemigroupsError:
358358
if the arguments *knd* and *tc* are not compatible. If the first item is
359359
``tc.kind()`` and the second is the parameter *knd*, then compatible
360-
arguments are (one-sided, one-sided), (two-sided, one-sided), and (two-sided,
361-
two-sided).
360+
arguments are (`onesided`, `onesided`), (`twosided`, `onesided`), and (`twosided`,
361+
`twosided`).
362362
)pbdoc");
363363

364364
thing.def(
@@ -380,7 +380,7 @@ This function puts a :any:`ToddCoxeter` instance back into the state
380380
that it would have been in if it had just been newly constructed from
381381
*knd* and *wg*.
382382
383-
:param knd: the kind (one-sided or two-sided) of the congruence.
383+
:param knd: the kind (`onesided` or `twosided`) of the congruence.
384384
:type knd: congruence_kind
385385
386386
:param wg: the word graph.
@@ -915,7 +915,7 @@ During any lookaheads that are performed, it is periodically checked what
915915
proportion of the active nodes have been killed since the previous such check.
916916
This function can be used to set the interval between these checks. The purpose
917917
of this setting is to allow lookaheads to be stopped early if the number of
918-
nodes being killed is too small (for example, if less than ``1%`` of nodes were
918+
nodes being killed is too small (for example, if less than 1% of nodes were
919919
killed in the previous second, then we might want to stop the lookahead early,
920920
since lookaheads take some time but may not result in many nodes being
921921
killed).

src/todd-coxeter.cpp

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ congruence of kind *knd* over the :any:`ToddCoxeter` instance *tc*. The
163163
:any:`ToddCoxeter` instance constructed in this way represents a quotient of
164164
the word graph represented by *tc*.
165165
166-
:param knd: the kind (one-sided or two-sided) of the congruence.
166+
:param knd: the kind (`onesided` or `twosided`) of the congruence.
167167
:type knd: congruence_kind
168168
169169
:param tc: the :any:`ToddCoxeter` instance.
@@ -191,7 +191,7 @@ This function puts a :any:`ToddCoxeter` instance back into the state
191191
that it would have been in if it had just been newly constructed from
192192
*knd* and *tc*.
193193
194-
:param knd: the kind (one-sided or two-sided) of the congruence.
194+
:param knd: the kind (`onesided` or `twosided`) of the congruence.
195195
:type knd: congruence_kind
196196
197197
:param tc: the :any:`ToddCoxeter` instance.
@@ -223,7 +223,7 @@ or right Cayley graph of a semigroup or monoid, then the
223223
:any:`ToddCoxeter` instance will represent a quotient of that
224224
semigroup.
225225
226-
:param knd: the kind (one-sided or two-sided) of the congruence.
226+
:param knd: the kind (`onesided` or `twosided`) of the congruence.
227227
:type knd: congruence_kind
228228
229229
:param wg: the word graph.
@@ -247,7 +247,7 @@ Re-initialize from :any:`congruence_kind` and :any:`WordGraph`.
247247
This function puts a :any:`ToddCoxeter` instance back into the state that it
248248
would have been in if it had just been newly constructed from *knd* and *wg*.
249249
250-
:param knd: the kind (one-sided or two-sided) of the congruence.
250+
:param knd: the kind (`onesided` or `twosided`) of the congruence.
251251
:type knd: congruence_kind
252252
253253
:param wg: the word graph.

src/ukkonen.cpp

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -571,9 +571,10 @@ tree consisting of ``list[int]``. The implementation in this class is based on:
571571
`https://cp-algorithms.com/string/suffix-tree-ukkonen.html <https://cp-algorithms.com/string/suffix-tree-ukkonen.html>`_
572572
573573
The suffix tree is updated when the member function :any:`ukkonen.add_word` is
574-
invoked. Every non-duplicate word added to the tree has a unique letter appended
575-
to the end. If a duplicate word is added, then the tree is not modified, but the
576-
value returned by :any:`Ukkonen.multiplicity` for the word is increased.
574+
invoked. Every non-duplicate word added to the tree has a unique letter
575+
appended to the end. If a duplicate word `w` is added, then the tree is not
576+
modified, but the value returned by :any:`Ukkonen.multiplicity` applied to `w`
577+
is increased.
577578
)pbdoc");
578579

579580
////////////////////////////////////////////////////////////////////////

0 commit comments

Comments
 (0)