Doc fixes#420
Merged
james-d-mitchell merged 9 commits intolibsemigroups:stable-1.4from May 1, 2026
Merged
Conversation
Member
Author
|
Any comments @Joseph-Edwards ? O/w I'll merge |
Collaborator
I'll take a look at it now |
Joseph-Edwards
requested changes
Apr 30, 2026
Collaborator
Joseph-Edwards
left a comment
Joseph-Edwards
left a comment
There was a problem hiding this comment.
A few small tweaks, then I'd be happy to merge. Thanks @james-d-mitchell!
| :rtype: int | Undefined | ||
|
|
||
| :raises LibsemigroupsError: if ``throw_if_node_index_not_active(parent)`` throws. | ||
| :raises LibsemigroupsError: if ``throw_if_node_index_not_active(parent)`` raises an exception. |
Collaborator
There was a problem hiding this comment.
I think this is a good change, but we should be consistent. There are instances of this in other files that we should probably change too.
Collaborator
There was a problem hiding this comment.
> rg "if .* throws\."
src/sims.cpp
113::raises LibsemigroupsError: if :any:`Presentation.throw_if_bad_alphabet_or_rules` throws.
src/ukkonen.cpp
64::raises LibsemigroupsError: if ``throw_if_contains_unique_letter(w)`` throws.
120::raises LibsemigroupsError: if ``u.throw_if_contains_unique_letter(w)`` throws.
179::raises LibsemigroupsError: if ``u.throw_if_contains_unique_letter(w)`` throws.
213::raises LibsemigroupsError: if ``u.throw_if_contains_unique_letter(w)`` throws.
247::raises LibsemigroupsError: if ``u.throw_if_contains_unique_letter(w)`` throws.
279::raises LibsemigroupsError: if ``u.throw_if_contains_unique_letter(w)`` throws.
315::raises LibsemigroupsError: if ``u.throw_if_contains_unique_letter(w)`` throws.
348::raises LibsemigroupsError: if ``u.throw_if_contains_unique_letter(w)`` throws.
382::raises LibsemigroupsError: if ``u.throw_if_contains_unique_letter(w)`` throws.
418::raises LibsemigroupsError: if ``u.throw_if_contains_unique_letter(w)`` throws.
451::raises LibsemigroupsError: if ``u.throw_if_contains_unique_letter(w)`` throws.
489::raises LibsemigroupsError: if ``u.throw_if_contains_unique_letter(w)`` throws.
529::raises LibsemigroupsError: if ``u.throw_if_contains_unique_letter(w)`` throws.
src/present.cpp
1297::raises LibsemigroupsError: if :any:`throw_if_bad_alphabet_or_rules` throws.
1322::raises LibsemigroupsError: if :any:`throw_if_bad_alphabet_or_rules` throws.
1363::raises LibsemigroupsError: if throw_if_bad_alphabet_or_rules throws.
1431::raises LibsemigroupsError: if ``p.throw_if_bad_alphabet_or_rules()`` throws.
1482: if :any:`Presentation.throw_if_bad_alphabet_or_rules` throws.
1516: if :any:`throw_if_bad_alphabet_or_rules` throws.
1586::raises LibsemigroupsError: if no inverses have been set, or if ``index(x)`` throws.
Member
Author
There was a problem hiding this comment.
Agreed but I think I'll fix this in a separate PR, so you don't have to re-review this one.
Merged
james-d-mitchell
force-pushed
the
doc-fixes
branch
from
45d1ae1 to
78eb02a
Compare
Joseph-Edwards
approved these changes
May 1, 2026
Closed
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.
A bunch of doc fixes many coming from codex.