Skip to content

Pages with [synopsis] not properly formatted #1972

New issue
New issue
Closed
#1921
Closed
Pages with [synopsis] not properly formatted#1972
#1921
@To1ne

Description

@To1ne
To1ne
opened on Mar 12, 2025
Collaborator

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

Activity

To1ne

To1ne commented on Mar 12, 2025

@To1ne
To1ne
on Mar 12, 2025
CollaboratorAuthor

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

Image

To1ne
mentioned this on Mar 12, 2025
dscho

dscho commented on Mar 12, 2025

@dscho
dscho
on Mar 12, 2025
Member

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

To1ne

To1ne commented on Mar 12, 2025

@To1ne
To1ne
on Mar 12, 2025
CollaboratorAuthor

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

dscho
linked a pull request that will close this issueNew manpage format #1921on Mar 12, 2025
jnavila
closed this as completedin #1921on Jul 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      Participants

      @To1ne@dscho

      Issue actions
        Pages with `[synopsis]` not properly formatted · Issue #1972 · git/git-scm.com