Skip to content

Conversation

thaJeztah
Copy link
Contributor

full diff: cpuguy83/go-md2man@v2.0.0...v2.0.1

  • Fix handling multiple definition descriptions
  • Fix inline markup causing table cells to split
  • Remove escaping tilde character (prevents tildes (~) from disappearing).
  • Do not escape dash, underscore, and ampersand (prevents ampersands (&) from disappearing).
  • Ignore unknown HTML tags to prevent noisy warnings

@thaJeztah
Copy link
Contributor Author

thaJeztah commented Jul 21, 2021

Ah, looks like some tests need updating because of some of the fixes

=== RUN   TestGenManSeeAlso
    man_docs_test.go:135: Second line after SEE ALSO wasn't correct: got \fBroot-bbb(1)\fP, \fBroot-ccc(1)\fP, not \fBroot\-bbb(1)\fP, \fBroot\-ccc(1)\fP
--- FAIL: TestGenManSeeAlso (0.00s)

@thaJeztah thaJeztah marked this pull request as draft July 21, 2021 09:25
full diff: cpuguy83/go-md2man@v2.0.0...v2.0.1

- Fix handling multiple definition descriptions
- Fix inline markup causing table cells to split
- Remove escaping tilde character (prevents tildes (`~`) from disappearing).
- Do not escape dash, underscore, and ampersand (prevents ampersands (`&`) from disappearing).
- Ignore unknown HTML tags to prevent noisy warnings

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
@github-actions github-actions bot added the area/docs-generation Generation of docs via Cobra label Jul 21, 2021
@thaJeztah thaJeztah marked this pull request as ready for review July 21, 2021 09:29
@thaJeztah
Copy link
Contributor Author

@eparis @estesp @cpuguy83 ptal

Copy link

@estesp estesp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link

@cpuguy83 cpuguy83 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Collaborator

@jpmcb jpmcb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this! LGTM

@jpmcb jpmcb merged commit 2a52778 into spf13:master Aug 5, 2021
@thaJeztah thaJeztah deleted the update_md2man branch August 5, 2021 17:09
@thaJeztah
Copy link
Contributor Author

Thanks for review/merge!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs-generation Generation of docs via Cobra
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants