Do not break hyphenated tokens when wrapping help text - #3812
Open
syedzeeshan-27 wants to merge 1 commit into
Open
Do not break hyphenated tokens when wrapping help text#3812syedzeeshan-27 wants to merge 1 commit into
syedzeeshan-27 wants to merge 1 commit into
Conversation
`wrap_text` left `textwrap.TextWrapper`'s default `break_on_hyphens=True` in place, so a usage line or help paragraph that had to wrap could split an option name at a hyphen, e.g. `--max-retry-count` became `--max-` / `retry-count`. Wrap only at whitespace instead. fixes pallets#3362
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
1 participant
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.
wrap_textbuilds click'sTextWrapperwithout overridingtextwrap.TextWrapper's defaultbreak_on_hyphens=True, so when a usage line or help paragraph has to wrap, an option name can be split at a hyphen:This change disables
break_on_hyphensso text wraps only at whitespace, keeping names like--max-retry-countintact. This also applies to help paragraphs (write_text), where prose mentioning an option (e.g. "use--enable-verbose-logginginstead") had the same problem; the trade-off is that ordinary hyphenated English words are also no longer split, which is the conventional choice for terminal help output. Long tokens that cannot fit on a line by themselves are still hard-broken as a last resort, unchanged.Added two regression tests (both fail without the fix), a changelog entry, and a
versionchangednote onwrap_text.fixes #3362