Add pydocstyle.line-width option
#7644
Comments
19 tasks
MichaReiser
added a commit
that referenced
this issue
Oct 24, 2023
## Summary This PR introduces a new `pycodestyl.max-line-length` option that allows overriding the global `line-length` option for `E501` only. This is useful when using the formatter and `E501` together, where the formatter uses a lower limit and `E501` is only used to catch extra-long lines. Closes #7644 ## Considerations ~~Our fix infrastructure asserts in some places that the fix doesn't exceed the configured `line-width`. With this change, the question is whether it should use the `pycodestyle.max-line-width` or `line-width` option to make that decision. I opted for the global `line-width` for now, considering that it should be the lower limit. However, this constraint isn't enforced and users not using the formatter may only specify `pycodestyle.max-line-width` because they're unaware of the global option (and it solves their need).~~ ~~I'm interested to hear your thoughts on whether we should use `pycodestyle.max-line-width` or `line-width` to decide on whether to emit a fix or not.~~ Edit: The linter users `pycodestyle.max-line-width`. The `line-width` option has been removed from the `LinterSettings` ## Test Plan Added integration test. Built the documentation and verified that the links are correct.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add a new
pydocstyle.line-widthoption that overrides the defaultline-widthsetting. This allows using the formatter withE501whereE501uses another configured line-length.Considered alternatives: Creating a new option specific to pycodestyle rather than a formatter-specific option feels more intuitive because the override is specific to this lint rule and then aligns with pydocstyle.max-doc-length.
The text was updated successfully, but these errors were encountered: