-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
[tool.ruff.lint]
usage in docs is inconsistent
#8449
Comments
Yes, always do |
Kind of yes. Using I think the downside of this approach is what you pointed out, that we now a mixture in our documentation that leads to confusion and also doesn't make it clear that |
Ah, great -- sounds like it's already headed towards a more consistent state, thanks all! |
This should be in a better state now 🤞 |
That is still the case though. |
☝️ That is true, I did see some inconsistencies linger for a bit after this issue got closed. All of the cases I originally noted have been resolved at this point though. I can't find any others. (I suspect we are good as of 0.2.0 because that's when the deprecation of the old names shows up in release notes?) |
Hey friends,
It seems like with the arrival of the formatter (neat!) the linter-specific configs are going to be nested under
tool.ruff.lint
rather than directly undertool.ruff
? I think that the docs are currently somewhat inconsistent with that change, though.For instance:
select
is undertool.ruff.lint
in the "Configuring Ruff" doc, butselect
seems like a top-level settings in the "Settings" docAlso in the "Configuring Ruff" doc is a mention of
tool.ruff.lint.per-file-ignores
andtool.ruff.lint.flake8-quotes
but when I go to the Settings section to look for those, it seems like they are still undertool.ruff
directly:per-file-ignores
,flake8-quotes
--
From snooping around in PRs (#7549) it seems like maybe that section is experimental and we're still deciding whether/how to show it?
I don't really know about the current status of that thinking.
I do think that current state of docs having a mix of
tool.ruff.lint
andtool.ruff
is a bit confusing. Maybe can get some explicit language explaining the state oftool.ruff.lint
versustool.ruff
? They still get merged together for v0.1.3?(Anyhow, thanks! Ruff is neat!)
The text was updated successfully, but these errors were encountered: