Add docsig as a pre-commit hook
#2580
Draft
Conversation
This file contains 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
github-actions
bot
added
CI
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2580 +/- ##
=======================================
Coverage 95.18% 95.18%
=======================================
Files 103 103
Lines 9412 9412
Branches 2153 2153
=======================================
Hits 8959 8959
Misses 276 276
Partials 177 177 ☔ View full report in Codecov by Sentry. |
github-actions
bot
added
docs
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.
docsigis a tool to check signature params for proper documentation." Applying this would be another check on our documentation.I'm leaning towards excluding tests from this check, largely because a test docstring is sometimes unnecessary if the name of the test fully indicates what the test is doing (i.e., when the name of the function is almost identical to what the docstring one-liner would say).
I'm creating this PR as a placeholder for later, since we probably want to fix problems with docstrings in more targeted PRs.