From 70c74c2b03218521c57e9083e74ac1fdf02ca943 Mon Sep 17 00:00:00 2001 From: Dan Jones Date: Mon, 31 Mar 2025 15:46:48 -0500 Subject: [PATCH] =?UTF-8?q?=F0=9F=92=A1=20Fix=20a=20few=20go=20doc=20comme?= =?UTF-8?q?nts?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- config.go | 4 ++-- gen_rand.go | 2 +- generators.go | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/config.go b/config.go index 0c06449..54456bf 100644 --- a/config.go +++ b/config.go @@ -10,7 +10,7 @@ type Config struct { generator Generator } -// NewConfig returns a new [Config] with the specified [Option]s. +// NewConfig returns a new [Config] with each [Option] specified. // With no Options, the Config uses an extension of .txt, a separator // of _, and the [UUID] [Generator]. func NewConfig(options ...Option) Config { @@ -25,7 +25,7 @@ func NewConfig(options ...Option) Config { return conf } -// AddOptions creates a new [Config] with the given [Option]s added. +// AddOptions creates a new [Config] with each [Option] added. func (c Config) AddOptions(options ...Option) Config { for _, opt := range options { opt(&c) diff --git a/gen_rand.go b/gen_rand.go index 7a9e9ea..69f0487 100644 --- a/gen_rand.go +++ b/gen_rand.go @@ -8,7 +8,7 @@ import ( "github.com/google/uuid" ) -// UUIDer is an interface for generating UUIDs. +// UUIDer is an interface for generating UUIDs, by the [UUID] [Generator]. // It is recommended that you use either the [UUIDv4] or [UUIDv7] variables. type UUIDer interface { UUID() (uuid.UUID, error) diff --git a/generators.go b/generators.go index fe7b59d..28b666b 100644 --- a/generators.go +++ b/generators.go @@ -28,7 +28,7 @@ func WithGenerator(g Generator) Option { } } -// ErrMissingGenerators is returned by a multi-generator if no [Generator]s are supplied. +// ErrMissingGenerators is returned by a multi-generator if a [Generator] isn't supplied. var ErrMissingGenerators = errors.New("no generators supplied") func missingGen(*Config) (string, error) {