Remove pydocstyle and configure ruff check for D rules#3384
Remove pydocstyle and configure ruff check for D rules#3384eracah wants to merge 12 commits intomosaicml:mainfrom
Conversation
| "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 |
|
|
||
| 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
left a comment
There was a problem hiding this comment.
things to change to make it work with "google" style
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: