💡 Improve go doc comments with internal links

This commit is contained in:
Dan Jones 2025-03-31 12:10:05 -05:00
commit c5a9f09166
8 changed files with 38 additions and 34 deletions

View file

@ -1,5 +1,6 @@
package nomino
// Config controls how the generatred filename is created.
type Config struct {
original string
prefix string
@ -9,7 +10,9 @@ type Config struct {
generator Generator
}
// NewConfig returns a new Config with the specified Options.
// NewConfig returns a new [Config] with the specified [Option]s.
// With no Options, the Config uses an extension of .txt, a separator
// of _, and the [UUID] [Generator].
func NewConfig(options ...Option) Config {
conf := Config{
extension: ".txt",
@ -22,7 +25,7 @@ func NewConfig(options ...Option) Config {
return conf
}
// AddOptions creates a new Config with options added.
// AddOptions creates a new [Config] with the given [Option]s added.
func (c Config) AddOptions(options ...Option) Config {
for _, opt := range options {
opt(&c)