Document the test-only intentions of this package #189
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
neild
reviewed
Feb 27, 2020
cmp/compare.go
Outdated
| @@ -6,6 +6,9 @@ | |||
| // | |||
| // This package is intended to be a more powerful and safer alternative to | |||
| // reflect.DeepEqual for comparing whether two values are semantically equal. | |||
| // It is intended to only be used in tests, as cmp may panic if it cannot | |||
| // compare the values. It's propensity towards panicking means that it is | |||
There was a problem hiding this comment.
Kept it in untracted form for the first occurrence. Used contracted form for later occurences.
There was a problem hiding this comment.
Oh, you were probably referring to the "it's", which is incorrect grammar. Sigh, the inability to highlight a specific word in GitHub PR is confusing.
neild
reviewed
Feb 27, 2020
neild
approved these changes
Feb 27, 2020
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.
This package was never intended to be used in production code.
Document the expectation that this package was only intended
to be used for writing tests.