Conversation
TextWrapper defaults to break_on_hyphens=True, causing long option names like --max-retry-count to be broken mid-hyphen at wrap boundaries. Set break_on_hyphens=False in wrap_text() since CLI options should never be split at hyphens. 6 new tests verifying options are not broken at hyphens. Fixes pallets#3362
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.
Problem
HelpFormatter.write_usagebreaks long option names at hyphens when wrapping.Root Cause
textwrap.TextWrapperdefaults tobreak_on_hyphens=True. When options like--max-retry-countland near the line wrap boundary, Python textwrap splits them at the hyphen.Fix
Set
break_on_hyphens=Falseinwrap_text()since CLI options should never be split at hyphens. One-line change insrc/click/formatting.py. 6 new tests.Fixes #3362