Add docstrings to exceptions and sort their list alphabetically #1422
Conversation
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
Pull Request Test Coverage Report for Build 14316249940Details
💛 - Coveralls |
|
I need to fix a conflict before merging, but thanks for documenting (again). We try to have obvious names, but clearly descriptions add a lot of value |
IvanIsCoding
approved these changes
Apr 7, 2025
SILIZ4
pushed a commit
to SILIZ4/rustworkx
that referenced
this pull request
Jul 4, 2025
…it#1422) Co-authored-by: Ivan Carvalho <8753214+IvanIsCoding@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 exceptions API was quite empty and since PyO3 allows adding docstrings to
create_exception, I moved the comments to docstrings and also completed and sorted alphabetically their list in the API docs.