Conversation
added 2 commits
August 28, 2026 14:00
HelpFormatter.write_usage() passed the argument string to wrap_text, which breaks long lines at hyphens by default. Usage lines for commands with many hyphenated options were therefore split mid-option (e.g. --disable-/cache-mode). Wrap usage arguments with break_on_hyphens=False so options stay intact, adding a matching parameter to wrap_text (default unchanged for other callers). Closes pallets#3362
Member
davidism
added
the
rejected AI
davidism
changed the title
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
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.
What
HelpFormatter.write_usage()wraps the argument string withwrap_text, which breaks long lines at hyphens by default. Usage lines for commands with many hyphenated options were rendered mid-option, e.g. at width 65:Fixes #3362.
Change
wrap_textgains abreak_on_hyphensparameter (defaultTrue, sowrite_textand other callers are unchanged).write_usagewraps usage arguments withbreak_on_hyphens=False, so wrapping happens on spaces only and options stay intact.Tests
test_write_usage_does_not_break_options_at_hyphenswith the issue's repro (10 hyphenated options at width 65): options remain intact and no line ends with a dangling-. Fails on the previous implementation (verified) and passes with the fix.