Skip to content
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

Pages with [synopsis] not properly formatted #1972

Open
To1ne opened this issue Mar 12, 2025 · 3 comments · May be fixed by #1921
Open

Pages with [synopsis] not properly formatted #1972

To1ne opened this issue Mar 12, 2025 · 3 comments · May be fixed by #1921

Comments

@To1ne
Copy link
Contributor

To1ne commented Mar 12, 2025

When a documentation file uses [synopsis] instead of [verse] the SYNOPSIS section is ill formatted.

URL for broken page

https://git-scm.com/docs/git-diff and https://git-scm.com/docs/git-clone

Problem

Image

Compared to

Image

Operating system and browser

Steps to reproduce

Other details
@To1ne
Copy link
Contributor Author

To1ne commented Mar 12, 2025

This happens in other places too, for example at https://git-scm.com/docs/git-diff-index#generate_patch_text_with_p :

Image

@To1ne To1ne linked a pull request Mar 12, 2025 that will close this issue
Open
@dscho
Copy link
Member

dscho commented Mar 12, 2025

@To1ne have you seen #1921? Maybe that addresses the problem?

@To1ne
Copy link
Contributor Author

To1ne commented Mar 12, 2025

Yes, I was just looking at that. Pretty cool!

@dscho dscho linked a pull request Mar 12, 2025 that will close this issue
New manpage format #1921
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

New manpage format git/git-scm.com
2 participants
@To1ne @dscho