diff --git a/mock/sonyflake_mock.go b/mock/sonyflake_mock.go index 70bc01a..f861ce1 100644 --- a/mock/sonyflake_mock.go +++ b/mock/sonyflake_mock.go @@ -1,6 +1,5 @@ -// Package mock offers implementations of interfaces defined in types.go -// This allows complete control over input / output for any given method that consumes -// a given type +// Package mock offers mock implementations of interfaces defined in types.go. +// This allows complete control over input / output for any given method that consumes a given type. package mock import ( @@ -10,7 +9,7 @@ import ( "github.com/sony/sonyflake/types" ) -// NewSuccessfulInterfaceAddrs returns a single private IP address +// NewSuccessfulInterfaceAddrs returns a single private IP address. func NewSuccessfulInterfaceAddrs() types.InterfaceAddrs { ifat := make([]net.Addr, 0, 1) ifat = append(ifat, &net.IPNet{IP: []byte{192, 168, 0, 1}, Mask: []byte{255, 0, 0, 0}}) @@ -20,14 +19,14 @@ func NewSuccessfulInterfaceAddrs() types.InterfaceAddrs { } } -// NewFailingInterfaceAddrs returns an error +// NewFailingInterfaceAddrs returns an error. func NewFailingInterfaceAddrs() types.InterfaceAddrs { return func() ([]net.Addr, error) { return nil, fmt.Errorf("test error") } } -// NewFailingInterfaceAddrs returns an empty slice of addresses +// NewNilInterfaceAddrs returns an empty slice of addresses. func NewNilInterfaceAddrs() types.InterfaceAddrs { return func() ([]net.Addr, error) { return []net.Addr{}, nil diff --git a/v2/mock/sonyflake_mock.go b/v2/mock/sonyflake_mock.go index 8de6107..8b53be0 100644 --- a/v2/mock/sonyflake_mock.go +++ b/v2/mock/sonyflake_mock.go @@ -1,6 +1,5 @@ -// Package mock offers implementations of interfaces defined in types.go -// This allows complete control over input / output for any given method that consumes -// a given type +// Package mock offers mock implementations of interfaces defined in types.go. +// This allows complete control over input / output for any given method that consumes a given type. package mock import ( @@ -10,7 +9,7 @@ import ( "github.com/sony/sonyflake/v2/types" ) -// NewSuccessfulInterfaceAddrs returns a single private IP address +// NewSuccessfulInterfaceAddrs returns a single private IP address. func NewSuccessfulInterfaceAddrs() types.InterfaceAddrs { ifat := make([]net.Addr, 0, 1) ifat = append(ifat, &net.IPNet{IP: []byte{192, 168, 0, 1}, Mask: []byte{255, 0, 0, 0}}) @@ -20,14 +19,14 @@ func NewSuccessfulInterfaceAddrs() types.InterfaceAddrs { } } -// NewFailingInterfaceAddrs returns an error +// NewFailingInterfaceAddrs returns an error. func NewFailingInterfaceAddrs() types.InterfaceAddrs { return func() ([]net.Addr, error) { return nil, fmt.Errorf("test error") } } -// NewFailingInterfaceAddrs returns an empty slice of addresses +// NewNilInterfaceAddrs returns an empty slice of addresses. func NewNilInterfaceAddrs() types.InterfaceAddrs { return func() ([]net.Addr, error) { return []net.Addr{}, nil