chore: minor godoc refactoring

pkg/gotenberg/cmd.go

@@ -13,16 +13,16 @@ import (
 	"go.uber.org/zap"
 )
 
-// Cmd wraps an exec.Cmd.
+// Cmd wraps an [exec.Cmd].
 type Cmd struct {
 	ctx     context.Context
 	logger  *zap.Logger
 	process *exec.Cmd
 }
 
-// Command creates a Cmd without a context. It configures the internal
-// exec.Cmd of Cmd so that we may kill its unix process and all its children
-// without creating orphans.
+// Command creates a [Cmd] without a context. It configures the internal
+// [exec.Cmd] of [Cmd] so that we may kill its unix process and all its
+// children without creating orphans.
 //
 // See https://medium.com/@felixge/killing-a-child-process-and-all-of-its-children-in-go-54079af94773.
 func Command(logger *zap.Logger, binPath string, args ...string) Cmd {
@@ -36,9 +36,9 @@ func Command(logger *zap.Logger, binPath string, args ...string) Cmd {
 	}
 }
 
-// CommandContext creates a Cmd with a context. It configures the internal
-// exec.Cmd of Cmd so that we may kill its unix process and all its children
-// without creating orphans.
+// CommandContext creates a [Cmd] with a context. It configures the internal
+// [exec.Cmd] of [Cmd] so that we may kill its unix process and all its
+// children without creating orphans.
 //
 // See https://medium.com/@felixge/killing-a-child-process-and-all-of-its-children-in-go-54079af94773.
 func CommandContext(ctx context.Context, logger *zap.Logger, binPath string, args ...string) (Cmd, error) {

pkg/gotenberg/context.go

@@ -5,7 +5,7 @@ import (
 	"reflect"
 )
 
-// Context is a struct which helps initializing modules. When provisioning, a
+// Context is a struct which helps to initialize modules. When provisioning, a
 // module may use the context to get other modules that it needs internally.
 type Context struct {
 	flags           ParsedFlags
@@ -13,8 +13,8 @@ type Context struct {
 	moduleInstances map[string]interface{}
 }
 
-// NewContext creates a Context.
-// In a module, prefer the Provisioner interface to get a Context.
+// NewContext creates a [Context].
+// In a module, prefer the [Provisioner] interface to get a [Context].
 func NewContext(
 	flags ParsedFlags,
 	descriptors []ModuleDescriptor,
@@ -32,7 +32,7 @@ func NewContext(
 //		flags := ctx.ParsedFlags()
 //		m.foo = flags.RequiredString("foo")
 //	}
-func (ctx Context) ParsedFlags() ParsedFlags {
+func (ctx *Context) ParsedFlags() ParsedFlags {
 	return ctx.flags
 }
 
@@ -100,7 +100,7 @@ func (ctx *Context) Modules(kind interface{}) ([]interface{}, error) {
 }
 
 // loadModule calls the Provision and/or Validate methods of the requested
-// module if it satisfies the Provisioner and/or Validator interfaces.
+// module if it satisfies the [Provisioner] and/or [Validator] interfaces.
 func (ctx *Context) loadModule(id string, instance interface{}) error {
 	if prov, ok := instance.(Provisioner); ok {
 		// The instance can be provisioned.

pkg/gotenberg/flags.go

@@ -8,7 +8,7 @@ import (
 	flag "github.com/spf13/pflag"
 )
 
-// ParsedFlags wraps a flag.FlagSet so that retrieving the typed values is
+// ParsedFlags wraps a [flag.FlagSet] so that retrieving the typed values is
 // easier.
 type ParsedFlags struct {
 	*flag.FlagSet

pkg/gotenberg/fs.go

@@ -14,7 +14,7 @@ type FileSystem struct {
 	workingDir string
 }
 
-// NewFileSystem initializes a new FileSystem instance with a unique working
+// NewFileSystem initializes a new [FileSystem] instance with a unique working
 // directory.
 func NewFileSystem() *FileSystem {
 	return &FileSystem{

pkg/gotenberg/logging.go

@@ -3,7 +3,7 @@ package gotenberg
 import "go.uber.org/zap"
 
 // LoggerProvider is an interface for a module that supplies a method for
-// creating a zap.Logger instance for use by other modules.
+// creating a [zap.Logger] instance for use by other modules.
 //
 //	func (m *YourModule) Provision(ctx *gotenberg.Context) error {
 //		provider, _ := ctx.Module(new(gotenberg.LoggerProvider))

pkg/gotenberg/metrics.go

@@ -15,7 +15,7 @@ type Metric struct {
 	Read func() float64
 }
 
-// MetricsProvider is a module interface which provides a list of Metric.
+// MetricsProvider is a module interface which provides a list of [Metric].
 //
 //	func (m *YourModule) Provision(ctx *gotenberg.Context) error {
 //		provider, _ := ctx.Module(new(gotenberg.MetricsProvider))