Uh oh!
There was an error while loading. Please reload this page.
Conversation
HelpFormatter.write_usage wrapped arguments with textwrap's default break_on_hyphens=True, so option names like --max-retry-count were split across lines. Thread break_on_hyphens through wrap_text and disable it for usage arguments. Fixespallets#3362 Signed-off-by: elix3r <157088510+22elix3r@users.noreply.github.com>
davidism
commented
Aug 27, 2026
Member
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 freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
HelpFormatter.write_usagewraps its argument string withwrap_text, which usestextwrap.TextWrapper's defaultbreak_on_hyphens=True. When a hyphenated option sits at the wrap width it is split mid-token, for example--max-retry-countbecomes--max-on one line andretry-counton the next.Related Issue
Fixes#3362
Changes Made
break_on_hyphensargument towrap_text(defaultTrue, so help body text is unchanged).break_on_hyphens=Falsefrom both wrapping branches ofHelpFormatter.write_usage.Testing
pytest tests/test_formatting.py(40 passed)pytest(1994 passed, 24 skipped, 1 xfailed)ruff check/ruff formaton the touched filesThe new tests cover
wrap_textitself, the issue's usage-line reproduction at width 65, and the long-prefix branch ofwrite_usage.Notes
Help text wrapping is unchanged. A token that is itself wider than the line can still be broken by
break_long_words.