Clarify documentation on Finish #194
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
Finish no longer has to be explicitly called on Controller with defer if the Controller was created with testing.T. We tried to just mark this as deprecated in uber-go#50 but doing so would break many users, so we reverted it in uber-go#85. In doing so we dropped some wordings from the doc that marked Finished as unnecessary for most cases. This PR fixes the docstring to guide users without explicitly marking the API deprecated.
JacobOaks
approved these changes
Jul 10, 2024
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.
Finish no longer has to be explicitly called on Controller with defer if the Controller was created with testing.T.
We tried to just mark this as deprecated in #50 but doing so would break many users, so we reverted it in #85.
In doing so we dropped some wordings from the doc that marked Finished as unnecessary for most cases.
This PR fixes the docstring to guide users without explicitly marking the API deprecated.