Various fixes for docstrings #711
Merged
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
This repository doesn't currently generate or validate the API documentation generated by Sphinx, but I found that there were problems doing so when manually attempted. We may consider adding API documentation generation in the future, but I found it useful to fix the problems we're carrying today.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #711 +/- ##
=======================================
Coverage 86.98% 86.98%
=======================================
Files 69 69
Lines 4088 4088
Branches 706 706
=======================================
Hits 3556 3556
Misses 421 421
Partials 111 111 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Crola1702
approved these changes
Nov 10, 2025
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.
This repository doesn't currently generate or validate the API documentation generated by Sphinx, but I found that there were problems doing so when manually attempted.
We may consider adding API documentation generation in the future, but I found it useful to fix the problems we're carrying today.