Remove pydocstyle and configure ruff check for D rules #3384
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
Skylion007
reviewed
Jun 8, 2024
Skylion007
reviewed
Jun 8, 2024
| "composer/algorithms/*" = ["D"] | ||
| "composer/datasets/*" = ["D"] | ||
| "composer/models/*" = ["D"] | ||
| "composer/trainer/activation_checkpointing.py" = ["D"] |
There was a problem hiding this comment.
You can also just add a specific noqa comment at the top of the file to disable it directly in the file.
There was a problem hiding this comment.
Why ignore algorithms/datasets/models?
There was a problem hiding this comment.
I just used the same ignoring that pydocstyle used. See the lines removed from the the pre-commit yaml
|
Our ruff version is really old, we may want to consider updating it. It may include more pydocstyle autofixes in newer versions or reduce any false positives / false negatives |
b-chu
reviewed
Jun 10, 2024
| @@ -14,7 +14,7 @@ | |||
| instances of the module type have been seen. The function should return a replacement | |||
| :class:`torch.nn.Module` if the module type should be replaced, or ``None`` otherwise. | |||
|
|
|||
| Args: | |||
| Args: | |||
| module (torch.nn.Module): Source module | |||
There was a problem hiding this comment.
module is double indented after Args
| "composer/algorithms/*" = ["D"] | ||
| "composer/datasets/*" = ["D"] | ||
| "composer/models/*" = ["D"] | ||
| "composer/trainer/activation_checkpointing.py" = ["D"] |
There was a problem hiding this comment.
Why ignore algorithms/datasets/models?
Co-authored-by: Aaron Gokaslan <aaronGokaslan@gmail.com>
eracah
commented
Jun 10, 2024
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.
Pydocstyle is now deprecated, so we remove it and configure ruff to do what it did.
Our pydocstyle did the following:
To enable the above functionality in ruff, we:
Also: