Doc fixes 3#425
Open
james-d-mitchell wants to merge 12 commits intolibsemigroups:stable-1.4from
Open
Conversation
james-d-mitchell
force-pushed
the
doc-fixes-3
branch
from
7415da1 to
0a6a032
Compare
james-d-mitchell
force-pushed
the
doc-fixes-3
branch
from
0a6a032 to
410082d
Compare
james-d-mitchell
force-pushed
the
doc-fixes-3
branch
from
410082d to
1c8d352
Compare
Joseph-Edwards
requested changes
May 6, 2026
Collaborator
Joseph-Edwards
left a comment
Joseph-Edwards
left a comment
There was a problem hiding this comment.
Some small tweaks and comments, but then I will be happy to merge. Thanks @james-d-mitchell
Comment on lines
1854
to
+1855
| :param n: maximum number of congruence classes. | ||
| :param n: the maximum number of congruence classes. |
Collaborator
There was a problem hiding this comment.
There should only be one of these
| the word graph represented by *tc*. | ||
|
|
||
| :param knd: the kind (onesided, or twosided) of the congruence. | ||
| :param knd: the kind (one-sided or two-sided) of the congruence. |
Collaborator
There was a problem hiding this comment.
I think this should probably be returned to what it was, or replaced with `onesided` or `twosided`.
Comment on lines
301
to
+302
| arguments are (one-sided, one-sided), (two-sided, one-sided), and (two-sided, | ||
| two-sided).)pbdoc"); | ||
| two-sided). |
Collaborator
There was a problem hiding this comment.
It might also be better to replace one-sided with `onesided` here. Same for two-sided
| semigroup. | ||
|
|
||
| :param knd: the kind (onesided or twosided) of the congruence. | ||
| :param knd: the kind (one-sided or two-sided) of the congruence. |
| *knd* and *tc*. | ||
|
|
||
| :param knd: the kind (onesided, or twosided) of the congruence. | ||
| :param knd: the kind (one-sided or two-sided) of the congruence. |
| the word graph represented by *tc*. | ||
|
|
||
| :param knd: the kind (onesided, or twosided) of the congruence. | ||
| :param knd: the kind (one-sided or two-sided) of the congruence. |
Collaborator
There was a problem hiding this comment.
same comment as above
| *knd* and *tc*. | ||
|
|
||
| :param knd: the kind (onesided, or twosided) of the congruence. | ||
| :param knd: the kind (one-sided or two-sided) of the congruence. |
| semigroup. | ||
|
|
||
| :param knd: the kind (onesided or twosided) of the congruence. | ||
| :param knd: the kind (one-sided or two-sided) of the congruence. |
| would have been in if it had just been newly constructed from *knd* and *wg*. | ||
|
|
||
| :param knd: the kind (onesided or twosided) of the congruence. | ||
| :param knd: the kind (one-sided or two-sided) of the congruence. |
Comment on lines
575
to
+576
| to the end. If a duplicate word is added, then the tree is not modified, but the | ||
| :any:`multiplicity` of the word is increased. | ||
| value returned by :any:`Ukkonen.multiplicity` for the word is increased. |
Collaborator
There was a problem hiding this comment.
I think something like this might be better:
If a duplicate word `w` is added, then the tree is not modified, but the
value returned by :any:`Ukkonen.multiplicity` applied to `w` is increased.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The third and final batch of doc fixes.