Skip to content
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

Rename pydocstyle.max-doc-length to max-doc-width #7574

Closed
Tracked by #7642
MichaReiser opened this issue Sep 21, 2023 · 1 comment · Fixed by #8150
Closed
Tracked by #7642

Rename pydocstyle.max-doc-length to max-doc-width #7574

MichaReiser opened this issue Sep 21, 2023 · 1 comment · Fixed by #8150
Assignees
Labels
configuration Related to settings and configuration

Comments

@MichaReiser
Copy link
Member

MichaReiser commented Sep 21, 2023

Rename pydocstyle.max-doc-length to doc-width to align with other text width options and clarify that the option is about the text width and not character or byte length.

The max-doc-length option should act as an alias but Ruff should warn and hint users towards migrating to the new option.

@MichaReiser MichaReiser added the configuration Related to settings and configuration label Sep 25, 2023
@MichaReiser MichaReiser added this to the Formatter: Beta milestone Sep 25, 2023
@ngnpope
Copy link
Contributor

ngnpope commented Sep 26, 2023

Wondering whether the max- prefix is relevant? 🤔

If we are going for line-width, as the general line width value (without max-), would doc-line-width make more sense?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
configuration Related to settings and configuration
Projects
None yet
2 participants