💡 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

@ -6,7 +6,7 @@ import (
"github.com/gosimple/slug"
)
// Option sets configuration parameters for Config.
// Option sets configuration parameters for [Config].
type Option func(c *Config)
// WithOriginal sets the original filename.
@ -18,7 +18,7 @@ func WithOriginal(o string) Option {
}
// WithOriginal sets the original filename as a slug.
// This should not be used with the Slug Generator (as it would be redundant).
// This should not be used with the [Slug] [Generator] (as it would be redundant).
func WithOriginalSlug(o string) Option {
return func(c *Config) {
c.original = slug.Make(o)
@ -26,7 +26,7 @@ func WithOriginalSlug(o string) Option {
}
// WithOriginal sets the original filename as a slug, taking the language into account.
// This should not be used with the Slug Generator (as it would be redundant).
// This should not be used with the [Slug] [Generator] (as it would be redundant).
func WithOriginalSlugLang(o, lang string) Option {
return func(c *Config) {
c.original = slug.MakeLang(o, lang)