Skip to content

Escape hyphens in manpage #132291

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Apr 9, 2025
Merged

Escape hyphens in manpage #132291

merged 1 commit into from
Apr 9, 2025

Conversation

stefanor
Copy link
Contributor

@stefanor stefanor commented Apr 8, 2025 •
edited
Loading

Based on the patch submitted in https://bugs.debian.org/1101406 as the result of running a linter on the manpage.

skirpichev
skirpichev reviewed Apr 8, 2025
View reviewed changes
@AA-Turner
Copy link
Member

Can we split the lint/formatting changes to a new PR, and only have substantive changes here?

@AA-Turner AA-Turner added the docs Documentation in the Doc dir label Apr 8, 2025
@github-project-automation github-project-automation bot moved this to Todo in Docs PRs Apr 8, 2025
@stefanor
Copy link
Contributor Author

stefanor commented Apr 9, 2025

Restricted this PR to just the hyphen escapes.

@stefanor stefanor changed the title Some manpage cleanups Escape hyphens in manpage Apr 9, 2025
@AA-Turner
Copy link
Member

AA-Turner commented Apr 9, 2025 •
edited
Loading

Do you have a rendered before/after preview? Is this purely a cosmetic change or does it have semantic differences?

Also, please avoid force-pushing, GitHub's interface copes badly with it making reviewing harder. All commits are squash-merged.

A

@stefanor stefanor force-pushed the manpage-lint branch 2 times, most recently from 6a3147a to 169c41e Compare April 9, 2025 12:29
@stefanor
Escape hyphens in manpage
cf3c883 
Based on the patch submitted in https://bugs.debian.org/1101406 as the
result of running a linter on the manpage.
@stefanor
Copy link
Contributor Author

stefanor commented Apr 9, 2025

Sorry about the force-pushes, I was just fixing up mistakes.

This is down to a functionally noop diff that uses a consistent style for minus signs: https://gist.github.com/stefanor/da32324f80e36f27819ba22ae0ab2098

Technically minus-signs are \- in roff, where - is used for hyphenation.

@AA-Turner AA-Turner added the needs backport to 3.13 bugs and security fixes label Apr 9, 2025
@AA-Turner AA-Turner enabled auto-merge (squash) April 9, 2025 22:41
@AA-Turner AA-Turner merged commit e523754 into python:main Apr 9, 2025
30 checks passed
@github-project-automation github-project-automation bot moved this from Todo to Done in Docs PRs Apr 9, 2025
@miss-islington-app
Copy link

Thanks @stefanor for the PR, and @AA-Turner for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Apr 9, 2025
@stefanor @miss-islington
Escape hyphens in manpage (pythonGH-132291)
f1fc2d3 
(cherry picked from commit e523754)

Co-authored-by: Stefano Rivera <stefano@rivera.za.net>
@bedevere-app
Copy link

bedevere-app bot commented Apr 9, 2025

GH-132334 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Apr 9, 2025
AA-Turner pushed a commit that referenced this pull request Apr 9, 2025
@miss-islington @stefanor
[3.13] Escape hyphens in manpage (GH-132291) (#132334)
f30a251 
Co-authored-by: Stefano Rivera <stefano@rivera.za.net>
stefanor added a commit to stefanor/cpython that referenced this pull request Apr 10, 2025
@stefanor
Manpage formatting tweaks
1afe878 
Following on from pythonGH-132291 this is the second part of the patch from
https://bugs.debian.org/1101406

This tweaks the formatting of a few bits of the manpage.
@stefanor stefanor mentioned this pull request Apr 10, 2025
Open
seehwan pushed a commit to seehwan/cpython that referenced this pull request Apr 16, 2025
@stefanor @seehwan80
Escape hyphens in manpage (python#132291)
7a0065b
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@skirpichev skirpichev skirpichev left review comments

@AA-Turner AA-Turner AA-Turner approved these changes

Assignees
No one assigned
Labels
docs Documentation in the Doc dir skip issue skip news
Projects
Docs PRs
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@stefanor @AA-Turner @skirpichev