assert: deprecate CompareType #1566
Merged
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
dolmen
added
pkg-assert
arjunmahishi
approved these changes
Mar 5, 2024
brackendawson
requested changes
Mar 5, 2024
|
Similar PR about deprecating a private type that should not have been exposed: #1441. |
brackendawson
approved these changes
Mar 6, 2024
Refactor Test_compareTwoValuesCorrectCompareResult table test to be more explicit: "compareTypes" renamed to "allowedResults".
Refactor compareTwoValues tests to free the 'compareResult' symbol name (for incoming use of this name in next commit).
Rename CompareType to compareResult to make it private. This type is used only in internal functions and is of no use for external users and should never have been made public. CompareType has been introduced by 0b4ff03 and appeared in releases since v1.6.0. Note: strictly speaking, this is a breaking change, but no external user should have ever used assert.CompareType as it made no sense in the assert API. A search on GitHub has revealed no use of it. https://github.com/search?q=assert.CompareType+language%3AGo&type=Repositories&ref=advsearch&l=Go&l=
Reinstate CompareType for full backward compatibility, but mark it as deprecated.
dolmen
force-pushed
the
assert-deprecate-CompareType
branch
from
05f46a6
to
a155d2a
Compare
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.
Summary
Mark
assert.CompareTypeas deprecated.Changes
Commits step by step:
compareResultsymbol name: d75ed1d, 539cfd9CompareTypetocompareResult: fc30ce6CompareTypebut mark it as deprecated: 05f46a6Motivation
assert.CompareTypehas been introduced by 0b4ff03 and published since v1.6.0, but it is in fact only for internal usage and should never have been exposed.A search of usage of
assert.CompareTypeon GitHub shows no results: https://github.com/search?q=assert.CompareType%20language%3AGo%20&type=repositoriesRelated issues
N/A