💡 Fix a few go doc comments
This commit is contained in:
parent
81e04ea319
commit
70c74c2b03
3 changed files with 4 additions and 4 deletions
|
|
@ -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)
|
||||
|
|
|
|||
|
|
@ -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)
|
||||
|
|
|
|||
|
|
@ -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) {
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue