Workaround go-md2man warning about HTML comments #2129
Closed
Conversation
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
go-md2man 2.0.2 (not 1.0.10) does not recognize HTML comments, triggering a warning. Work around that, just to have a silent build. This uses a "comment" syntax by defining a reference-style link ( https://stackoverflow.com/a/20885980 ). Alternatively, go-md2man _does_ recognize comments inline inside a paragraph, so preceding the HTML comment with a space would probably work as well. Either way is _weird_, and we can't add a comment to explain the comment mechanism... so use the more visually distinct alternative to hopefully minimize regressions; using a leading space would tempt future readers to just remove the space, thinking it's a mistake. Signed-off-by: Miloslav Trmač <[email protected]>
rahilarious
approved these changes
Sep 21, 2023
Contributor
rahilarious
left a comment
rahilarious
left a comment
There was a problem hiding this comment.
That was a rapid one. Awesome. LGTM
Member
|
LGTM |
Collaborator
Author
|
On… second… thought, alternatively, we could actually fix |
Member
|
Both options are OK to me |
Collaborator
Author
|
Yeah, let’s fix this at the source instead: cpuguy83/go-md2man#104 . |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 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.
go-md2man 2.0.2 (not 1.0.10) does not recognize HTML comments, triggering a warning.
Work around that, just to have a silent build.
This uses a "comment" syntax by defining a reference-style link ( https://stackoverflow.com/a/20885980 ).
Alternatively, go-md2man does recognize comments inline inside a paragraph, so preceding the HTML comment with a space would probably work as well.
Either way is weird, and we can't add a comment to explain the comment mechanism... so use the more visually distinct alternative to hopefully minimize regressions; using a leading space would tempt future readers to just remove the space, thinking it's a mistake.
Fixes #2128 .