Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify documentation on Finish #194

Merged
merged 1 commit into from
Jul 10, 2024
Merged

Commits on Jul 10, 2024

  1. Clarify documentation on Finish

    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.
    sywhang committed Jul 10, 2024
    Configuration menu
    Copy the full SHA
    3b6f221 View commit details
    Browse the repository at this point in the history