docs(types): unify and clarify package and type docstrings for types.go in v1 and v2

This commit is contained in:
Yoshiyuki Mineo
2025-05-04 18:02:49 +09:00
parent 7b636bf93a
commit 901da0b022
2 changed files with 6 additions and 6 deletions

View File

@@ -1,8 +1,8 @@
// Package Types defines type signatures used throughout SonyFlake. This allows for
// fine-tuned control over imports, and the ability to mock out imports as well
// Package types defines type signatures used throughout sonyflake.
// This provides the ability to mock out imports.
package types
import "net"
// InterfaceAddrs defines the interface used for retrieving network addresses
// InterfaceAddrs defines the interface used for retrieving network addresses.
type InterfaceAddrs func() ([]net.Addr, error)

View File

@@ -1,8 +1,8 @@
// Package Types defines type signatures used throughout SonyFlake. This allows for
// fine-tuned control over imports, and the ability to mock out imports as well
// Package types defines type signatures used throughout sonyflake.
// This provides the ability to mock out imports.
package types
import "net"
// InterfaceAddrs defines the interface used for retrieving network addresses
// InterfaceAddrs defines the interface used for retrieving network addresses.
type InterfaceAddrs func() ([]net.Addr, error)