-
Notifications
You must be signed in to change notification settings - Fork 9
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: use pydoclint
as a documentation linter
#212
Merged
Merged
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
Codecov Report
@@ Coverage Diff @@
## main #212 +/- ##
==========================================
+ Coverage 89.55% 89.57% +0.01%
==========================================
Files 69 69
Lines 1446 1448 +2
==========================================
+ Hits 1295 1297 +2
Misses 151 151
|
d0choa
approved these changes
Oct 31, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great
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.
Checks between a function's arguments and types and its docstrings were lost in the transition to Ruff.
It is in Ruff's plans to bring this functionality (issue), but they haven't started yet.
For the time being I propose using
pydoclint
, a high performance alternative to darglint (the tool that flake8 relied on).This PR contains:
pydoclint
to the projectmake check
rulepydoclint
as one of the pre commit hookstests/airflow/test_dag.py
to comment out a failing testtest_no_import_errors