From 901da0b0224eafce36eec4797a39eaad139e9671 Mon Sep 17 00:00:00 2001 From: Yoshiyuki Mineo Date: Sun, 4 May 2025 18:02:49 +0900 Subject: [PATCH] docs(types): unify and clarify package and type docstrings for types.go in v1 and v2 --- types/types.go | 6 +++--- v2/types/types.go | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/types/types.go b/types/types.go index 57fa350..1b53613 100644 --- a/types/types.go +++ b/types/types.go @@ -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) diff --git a/v2/types/types.go b/v2/types/types.go index 57fa350..1b53613 100644 --- a/v2/types/types.go +++ b/v2/types/types.go @@ -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)