Docs (linter.md): clarify that Python files are always searched for in subdirectories#15882
Merged
AlexWaygood merged 2 commits intoastral-sh:mainfrom Feb 4, 2025
Merged
Docs (linter.md): clarify that Python files are always searched for in subdirectories#15882AlexWaygood merged 2 commits intoastral-sh:mainfrom
linter.md): clarify that Python files are always searched for in subdirectories#15882AlexWaygood merged 2 commits intoastral-sh:mainfrom
Conversation
AlexWaygood
reviewed
Feb 3, 2025
Comment on lines
10
to
20
| `ruff check` is the primary entrypoint to the Ruff linter. It accepts a list of files or | ||
| directories, and lints all discovered Python files, optionally fixing any fixable errors: | ||
| directories, and lints all discovered Python files (including those in subdirectories), optionally | ||
| fixing any fixable errors: | ||
|
|
||
| ```console | ||
| $ ruff check # Lint all files in the current directory. | ||
| $ ruff check --fix # Lint all files in the current directory, and fix any fixable errors. | ||
| $ ruff check --watch # Lint all files in the current directory, and re-lint on change. | ||
| $ ruff check path/to/code/ # Lint all files in `path/to/code` (and any subdirectories). | ||
| $ ruff check # Lint files in the current directory and any subdirectories. | ||
| $ ruff check --fix # Lint files in the current directory and any subdirectories and fix any fixable errors. | ||
| $ ruff check --watch # Lint files in the current directory and any subdirectories and re-lint on change. | ||
| $ ruff check path/to/code/ # Lint files in `path/to/code` and any subdirectories. | ||
| ``` |
Member
There was a problem hiding this comment.
I can see how this is unclear on main, but the suggested rewording here does feel a little repetitive now. What about something like this?
`ruff check` is the primary entrypoint to the Ruff linter. It accepts a list of files or
directories, and lints all discovered Python files, optionally fixing any fixable errors.
When linting a directory, Ruff searches for Python files recursively in that directory
and all its subdirectories:
```console
$ ruff check # Lint all files in the current directory.
$ ruff check --fix # Lint all files in the current directory, and fix any fixable errors.
$ ruff check --watch # Lint all files in the current directory, and re-lint on change.
$ ruff check path/to/code/ # Lint all files in `path/to/code`
```
Contributor
Author
There was a problem hiding this comment.
Mmm, yes that's better! Well done :)
Contributor
Author
There was a problem hiding this comment.
PS do you have opinions on:
Lint all files in the current directory.
vs.
Lint files starting from the current directory.
I prefer the latter since it hints there is some filtering and recursion without losing clarity, e.g. only Python files, respect .gitignore, etc.
AlexWaygood
changed the title
linter.mdlinter.md): clarify that Python files are always searched for in subdirectories
…n subdirectories.
dcreager
added a commit
that referenced
this pull request
Feb 4, 2025
* main: (66 commits) [red-knot] Use ternary decision diagrams (TDDs) for visibility constraints (#15861) [`pyupgrade`] Rename private type parameters in PEP 695 generics (`UP049`) (#15862) Simplify the `StringFlags` trait (#15944) [`flake8-pyi`] Make `PYI019` autofixable for `.py` files in preview mode as well as stubs (#15889) Docs (`linter.md`): clarify that Python files are always searched for in subdirectories (#15882) [`flake8-pyi`] Make PEP-695 functions with multiple type parameters fixable by PYI019 again (#15938) [red-knot] Use unambiguous invalid-syntax-construct for suppression comment test (#15933) Make `Binding::range()` point to the range of a type parameter's name, not the full type parameter (#15935) Update black deviations (#15928) [red-knot] MDTest: Fix line numbers in error messages (#15932) Preserve triple quotes and prefixes for strings (#15818) [red-knot] Hand-written MDTest parser (#15926) [`pylint`] Fix missing parens in unsafe fix for `unnecessary-dunder-call` (`PLC2801`) (#15762) nit: docs for ignore & select (#15883) [airflow] `BashOperator` has been moved to `airflow.providers.standard.operators.bash.BashOperator` (AIR302) (#15922) [`flake8-logging`] `.exception()` and `exc_info=` outside exception handlers (`LOG004`, `LOG014`) (#15799) [red-knot] Enforce specifying paths for mdtest code blocks in a separate preceding line (#15890) [red-knot] Internal refactoring of visibility constraints API (#15913) [red-knot] Implicit instance attributes (#15811) [`flake8-comprehensions`] Handle extraneous parentheses around list comprehension (`C403`) (#15877) ...
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Nits related to clarity of which files are linted
Hi!
I noticed no mention of recursing through sub-dirs and only the fourth example:
ruff check path/to/code/included the phrase: "and any subdirectories" leading me to believe only providing a path would recurse and the others would not. I don't think that's the actual behavior. It does feel a bit repetitive to say so in each example and in the intro paragraph, but I do somewhat like the clarity.Also, I opted to remove the "all" from "Lint all files in the current directory." (and others) since I presume it doesn't lint all files, only "all discovered Python files". Without the "all", I think it's clear many files will be linted, and it gives
a hint that further logic exists for filtering.