Rename "--line-length" option to "--page-width". #1577
Merged
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
The formatter has always been inconsistent about how to refer to the limit that it tries to fit code in. The option name (which is older than when I started working on the formatter) is "--line-length". But the public API and all of the internal code uses "page width". This renames that option to "--page-width". The old name is still supported (but hidden in help) for backwards compatibility. In practice, this option isn't used often, so this likely won't affect many users.
natebosch
approved these changes
Oct 10, 2024
Co-authored-by: Nate Bosch <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
The formatter has always been inconsistent about how to refer to the limit that it tries to fit code in. The option name (which is older than when I started working on the formatter) is "--line-length". But the public API and all of the internal code uses "page width".
This renames that option to "--page-width". The old name is still supported (but hidden in help) for backwards compatibility.
In practice, this option isn't used often, so this likely won't affect many users. We've already made a major version bump, so now seems like a good time to clean things up as much as possible.
cc @johnmccutchan since the inconsistency was bugging you. :)