mock: simpler deprecation doc for AnythingOfTypeArgument

Co-authored-by: Bracken <abdawson@gmail.com>
pull/1569/head
Olivier Mengué 2024-04-23 15:23:21 +02:00 committed by GitHub
parent aca1890ec1
commit 8c324a0bbd
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 6 additions and 16 deletions

View File

@ -766,25 +766,15 @@ const (
// AnythingOfTypeArgument contains the type of an argument
// for use when type checking. Used in Diff and Assert.
//
// Deprecated: this is an implementation detail that must not be used. Use the [AnythingOfType] constructor instead.
// Deprecated: this is an implementation detail that must not be used. Use the [AnythingOfType] constructor instead, example:
//
// If AnythingOfTypeArgument is used as a function return value type you can usually replace
// the function with a variable. Example:
// m.On("Do", mock.AnythingOfType("string"))
//
// func anyString() mock.AnythingOfTypeArgument {
// return mock.AnythingOfType("string")
// All explicit type declarations can be replaced with interface{} as is expected by [Mock.On], example:
//
// func anyString interface{} {
// return mock.AnythingOfType("string")
// }
//
// Can be replaced by:
//
// func anyString() interface{} {
// return mock.IsType("")
// }
//
// It could even be replaced with a variable:
//
// var anyString = mock.AnythingOfType("string")
// var anyString = mock.IsType("") // alternative
type AnythingOfTypeArgument = anythingOfTypeArgument
// anythingOfTypeArgument is a string that contains the type of an argument