You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I was checking the various options for tool.ruff.format and in particular I wanted to add additional exclusions to the formatter (in addition to the exclusions in tool.ruff.
A list of file patterns to exclude from formatting in addition to the files excluded globally.
I had two doubts about this:
The use of the keyword exclude instead of extend-exclude might make you think that this list is not "additive" / on top of the global one. (changing this would be a kind of breaking change though and the current behaviour is documented)
The doc within the tool.ruff.format section of exclude says:
Note that you'll typically want to use extend-exclude to modify the excluded paths.
However, no such option is available for the formatter so one might confuse the tool.ruff.format.exclude behavior with the behaviour of the global tool.ruff.exclude (which is not additive). This text seems to be a copy-paste from the global exclude option documentation
The text was updated successfully, but these errors were encountered:
…mat` config docs (#8302)
## Summary
Remove wrong note on `tool.ruff.format` `exclude` option from
documentation which is referencing `extend-exclude` even if it's not
relevant for the formatter options (`exclude` is additive). See #8301
## Test Plan
N/A (Docs change)
I was checking the various options for
tool.ruff.format
and in particular I wanted to add additional exclusions to the formatter (in addition to the exclusions intool.ruff
.The documentation of this option can be found at: https://docs.astral.sh/ruff/settings/#format-exclude
The documentation correctly says
I had two doubts about this:
exclude
instead ofextend-exclude
might make you think that this list is not "additive" / on top of the global one. (changing this would be a kind of breaking change though and the current behaviour is documented)tool.ruff.format
section ofexclude
says:However, no such option is available for the formatter so one might confuse the
tool.ruff.format.exclude
behavior with the behaviour of the globaltool.ruff.exclude
(which is not additive). This text seems to be a copy-paste from the globalexclude
option documentationThe text was updated successfully, but these errors were encountered: