docs: clarify docstring about function parameters being of non-identical types (#167)

This commit is contained in:
Robert van Gent
2019-05-10 14:11:27 -07:00
committed by GitHub
parent 2183ee4806
commit c1a359a7ca

View File

@@ -36,9 +36,9 @@ type ProviderSet struct{}
// Passing a function value to NewSet declares that the function's first // Passing a function value to NewSet declares that the function's first
// return value type will be provided by calling the function. The arguments // return value type will be provided by calling the function. The arguments
// to the function will come from the providers for their types. As such, all // to the function will come from the providers for their types. As such, all
// the parameters must be of non-identical types. The function may optionally // the function's parameters must be of non-identical types. The function may
// return an error as its last return value and a cleanup function as the // optionally return an error as its last return value and a cleanup function
// second return value. A cleanup function must be of type func() and is // as the second return value. A cleanup function must be of type func() and is
// guaranteed to be called before the cleanup function of any of the // guaranteed to be called before the cleanup function of any of the
// provider's inputs. If any provider returns an error, the injector function // provider's inputs. If any provider returns an error, the injector function
// will call all the appropriate cleanup functions and return the error from // will call all the appropriate cleanup functions and return the error from