uber-go / mock

GoMock is a mocking framework for the Go programming language.
Apache License 2.0
2.33k stars 121 forks source link

Clarify documentation on Finish #194

Closed sywhang closed 4 months ago

sywhang commented 4 months ago

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.