Improve docs on config file precedence #18034
Closed
Conversation
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
MichaReiser
reviewed
May 13, 2025
MichaReiser
reviewed
May 13, 2025
Comment on lines
-305
to
-309
| All of the above rules apply equivalently to `pyproject.toml`, `ruff.toml`, and `.ruff.toml` files. | ||
| If Ruff detects multiple configuration files in the same directory, the `.ruff.toml` file will take | ||
| precedence over the `ruff.toml` file, and the `ruff.toml` file will take precedence over | ||
| the `pyproject.toml` file. | ||
|
|
There was a problem hiding this comment.
I prefered this phrasing because it is more specific about when the precedence applies (it applies on a per directory level)
There was a problem hiding this comment.
Would it work for you if we keep the exact wording and just move the lines 306-308 up?
When working with ruff, I fell into the trap to have `.ruff.toml` and `pyproject.toml` config files. It took me some time to find the precedence rules from the docs. This PR aims to make the docs slightly more clear. - In the section "Config file discovery" the precedence was described quite lengthy at the very end of the section. I propose it's more concise to describe this with a single sentence immediately after stating that there can be one config file per directory.
timhoffm
force-pushed
the
doc-config-preference
branch
from
cd9df9a to
89f106f
Compare
|
I've kept the original phrasing and just move the text up. Feel free to merge or close depending on what makes more sense to you. |
|
I slightly prefer the currnet structure. That's why I'll close this PR. But thanks for discussing this change |
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.
When working with ruff, I fell into the trap of having
.ruff.tomlandpyproject.tomlconfig files. It took me some time to find the precedence rules from the docs. This PR aims to make the docs slightly more clear.