Skip to content

Doc consistency#297

Merged
james-d-mitchell merged 5 commits intolibsemigroups:v1from
Joseph-Edwards:doc-consistency
Jul 8, 2025
Merged

Doc consistency#297
james-d-mitchell merged 5 commits intolibsemigroups:v1from
Joseph-Edwards:doc-consistency

Conversation

@Joseph-Edwards
Copy link
Copy Markdown
Collaborator

This PR adds checks that the docstring is in a consistent order, and that the parameters in the signature have the same name and typehints as the parameters in the docstrings. It also fixes any warnings that arise as a result.

This commit fixes the order for:
 * Bipartition
 * Blocks
 * BMat8
 * Matrix
 * transf
 * presentation examples
 * to function
 * AhoCorasick
 * WordGraph
 * Action
 * Congruence
 * Runner
 * FroidurePin
 * Kambites
 * Konieczny
 * ToddCoxeter
@james-d-mitchell
Copy link
Copy Markdown
Member

So, ready to merge?

Comment thread docs/source/data-structures/presentations/to-present.rst Outdated
@james-d-mitchell james-d-mitchell merged commit 4b71280 into libsemigroups:v1 Jul 8, 2025
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants