Fix reversed Got/Expected in expectFileContent in docs_test.go #1320
Conversation
This file contains 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
anthonyfok
force-pushed
the
fix-reversed-got-expected-in-expectFileContent
branch
from
499e1d7
to
217b8f3
Compare
rliebz
approved these changes
Jan 3, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What type of PR is this?
What this PR does / why we need it:
To fix reversed Got/Expected in expectFileContent (in docs_test.go).
The bug confused me (as a developer) when bumping github.com/cpuguy83/go-md2man/v2 to v2.0.1 (see PR #1321) and noticed go-md2man generated output ended up in "Expected".
Which issue(s) this PR fixes:
None
Testing
I edited testdata/expected-doc-full.man and noticed my change ended up in "Got" instead of "Expected".
I then changed some test cases in app_test.go and convinced myself expect() is OK (Expected/Got not reversed), and eventually confirmed that the bug is in expectFileContent() in docs_test.go.
Finally, after applying this fix, I confirmed that my local change to testdata/expected-doc-full.man would indeed end up in the "Expected" section of TestToMan and TestToManWithSection output.
Release Notes