gh-145649: Fix man page text wrapping for -X option#145656
Merged
vstinner merged 4 commits intopython:mainfrom Mar 16, 2026
Merged
gh-145649: Fix man page text wrapping for -X option#145656vstinner merged 4 commits intopython:mainfrom
vstinner merged 4 commits intopython:mainfrom
Conversation
Replace hardcoded space indentation with proper troff macros (.TP, .RS/.RE, .IP) for -X sub-options so text wraps correctly at any terminal width. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
All commit authors signed the Contributor License Agreement. |
|
Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool. If this change has little impact on Python users, wait for a maintainer to apply the |
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
vstinner
approved these changes
Mar 13, 2026
Member
vstinner
left a comment
There was a problem hiding this comment.
LGTM. I don't speak roff markup, but the output looks correct.
I tested with man Misc/python.man on Linux.
Contributor
Author
|
Thanks for taking a look! |
|
Sorry, @mvanhorn and @vstinner, I could not cleanly backport this to |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Mar 16, 2026
…45656) Replace hardcoded space indentation with proper troff macros (.TP, .RS/.RE, .IP) for -X sub-options so text wraps correctly at any terminal width. (cherry picked from commit 36b5284) Co-authored-by: Matt Van Horn <mvanhorn@users.noreply.github.com> Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
|
GH-146015 is a backport of this pull request to the 3.14 branch. |
Member
|
Thanks, I merged your PR. I backported it to 3.14. |
vstinner
pushed a commit
that referenced
this pull request
Mar 16, 2026
#146015) gh-145649: Fix man page text wrapping for -X option (GH-145656) Replace hardcoded space indentation with proper troff macros (.TP, .RS/.RE, .IP) for -X sub-options so text wraps correctly at any terminal width. (cherry picked from commit 36b5284) Co-authored-by: Matt Van Horn <mvanhorn@users.noreply.github.com> Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
Contributor
Contributor
Author
|
Thanks for the review and merge, @vstinner! |
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
3 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.
Fixes #145649.
The
-Xoption descriptions in the man page (Misc/python.man) used hardcoded space indentation for sub-options. Troff treats lines starting with spaces as preformatted text that does not wrap, causing the descriptions to break incorrectly at narrow terminal widths - words would split across lines at the left margin instead of reflowing within the indented block.This replaces the inline indentation with proper troff macros:
.TPfor each-Xsub-option (tagged paragraph with the option as label).RS/.REfor nesting the sub-options within the parent-Xentry.IPwith bullet markers for the-X devfeature listThe descriptions now flow and wrap correctly at any terminal width, matching the style used by other options in the same man page.
This contribution was developed with AI assistance (Claude Code).