docs(godoc): fix a bunch of typos

pkg/gotenberg/cmd.go

@@ -74,7 +74,7 @@ func (cmd *Cmd) Start() error {
 }
 
 // Wait waits for the command to complete. It should be called when using the
-// Start method, so that the command does not leak zombies.
+// Start method so that the command does not leak zombies.
 func (cmd *Cmd) Wait() error {
 	err := cmd.process.Wait()
 	if err != nil {
@@ -84,7 +84,7 @@ func (cmd *Cmd) Wait() error {
 	return nil
 }
 
-// Exec executes the command and wait for its completion or until the context
+// Exec executes the command and waits for its completion or until the context
 // is done. In any case, it kills the unix process and all its children.
 func (cmd *Cmd) Exec() (int, error) {
 	if cmd.ctx == nil {

pkg/gotenberg/context.go

@@ -5,7 +5,7 @@ import (
 	"reflect"
 )
 
-// Context is a struct which helps to initialize modules. When provisioning, a
+// Context is a struct that 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
@@ -58,7 +58,7 @@ func (ctx *Context) Module(kind interface{}) (interface{}, error) {
 	return mods[0], nil
 }
 
-// Modules returns the list of modules which satisfies the requested interface.
+// Modules return the list of modules which satisfies the requested interface.
 //
 //	func (m *YourModule) Provision(ctx *gotenberg.Context) error {
 //		mods, _ := ctx.Modules(new(ModuleInterface))

pkg/gotenberg/fs.go

@@ -23,7 +23,7 @@ func (o *OsMkdirAll) MkdirAll(path string, perm os.FileMode) error { return os.M
 
 // PathRename defines the method signature for renaming files. Implement this
 // interface if you don't want to rely on [os.Rename], notably for testing
-// purpose.
+// purposes.
 type PathRename interface {
 	// Rename uses the same signature as [os.Rename].
 	Rename(oldpath, newpath string) error

pkg/gotenberg/gc.go

@@ -11,7 +11,7 @@ import (
 )
 
 // GarbageCollect scans the root path and deletes files or directories with
-// names containing specific substrings and before a given experiation time.
+// names containing specific substrings and before a given expiration time.
 func GarbageCollect(logger *zap.Logger, rootPath string, includeSubstr []string, expirationTime time.Time) error {
 	logger = logger.Named("gc")
 

pkg/gotenberg/gc_test.go

@@ -28,29 +28,29 @@ func TestGarbageCollect(t *testing.T) {
 		{
 			scenario: "remove include substrings",
 			rootPath: func() string {
-				path := fmt.Sprintf("%s/a_directory", os.TempDir())
+				p := fmt.Sprintf("%s/a_directory", os.TempDir())
 
-				err := os.MkdirAll(path, 0o755)
+				err := os.MkdirAll(p, 0o755)
 				if err != nil {
 					t.Fatalf("expected no error but got: %v", err)
 				}
 
-				err = os.WriteFile(fmt.Sprintf("%s/a_foo_file", path), []byte{1}, 0o755)
+				err = os.WriteFile(fmt.Sprintf("%s/a_foo_file", p), []byte{1}, 0o755)
 				if err != nil {
 					t.Fatalf("expected no error but got: %v", err)
 				}
 
-				err = os.WriteFile(fmt.Sprintf("%s/a_bar_file", path), []byte{1}, 0o755)
+				err = os.WriteFile(fmt.Sprintf("%s/a_bar_file", p), []byte{1}, 0o755)
 				if err != nil {
 					t.Fatalf("expected no error but got: %v", err)
 				}
 
-				err = os.WriteFile(fmt.Sprintf("%s/a_baz_file", path), []byte{1}, 0o755)
+				err = os.WriteFile(fmt.Sprintf("%s/a_baz_file", p), []byte{1}, 0o755)
 				if err != nil {
 					t.Fatalf("expected no error but got: %v", err)
 				}
 
-				return path
+				return p
 			}(),
 			includeSubstr:   []string{"foo", path.Join(os.TempDir(), "/a_directory/a_bar_file")},
 			expectError:     false,
@@ -81,18 +81,18 @@ func TestGarbageCollect(t *testing.T) {
 			}
 
 			for _, name := range tc.expectNotExists {
-				path := fmt.Sprintf("%s/%s", tc.rootPath, name)
-				_, err = os.Stat(path)
+				p := fmt.Sprintf("%s/%s", tc.rootPath, name)
+				_, err = os.Stat(p)
 				if !os.IsNotExist(err) {
-					t.Errorf("expected '%s' not to exist but it does: %v", path, err)
+					t.Errorf("expected '%s' not to exist but it does: %v", p, err)
 				}
 			}
 
 			for _, name := range tc.expectExists {
-				path := fmt.Sprintf("%s/%s", tc.rootPath, name)
-				_, err = os.Stat(path)
+				p := fmt.Sprintf("%s/%s", tc.rootPath, name)
+				_, err = os.Stat(p)
 				if os.IsNotExist(err) {
-					t.Errorf("expected '%s' to exist but it does not: %v", path, err)
+					t.Errorf("expected '%s' to exist but it does not: %v", p, err)
 				}
 			}
 		})

pkg/gotenberg/logging.go

@@ -18,7 +18,7 @@ type LoggerProvider interface {
 	Logger(mod Module) (*zap.Logger, error)
 }
 
-// LeveledLogger is wrapper around a [zap.Logger] so that it may be used by a
+// LeveledLogger is a wrapper around a [zap.Logger] so that it may be used by a
 // [retryablehttp.Client].
 type LeveledLogger struct {
 	logger *zap.Logger
@@ -31,22 +31,22 @@ func NewLeveledLogger(logger *zap.Logger) *LeveledLogger {
 	}
 }
 
-// Error logs a message at error level using the wrapped zap.Logger.
+// Error logs a message at the error level using the wrapped zap.Logger.
 func (leveled LeveledLogger) Error(msg string, keysAndValues ...interface{}) {
 	leveled.logger.Error(fmt.Sprintf("%s: %+v", msg, keysAndValues))
 }
 
-// Warn logs a message at warning level using the wrapped zap.Logger.
+// Warn logs a message at the warning level using the wrapped zap.Logger.
 func (leveled LeveledLogger) Warn(msg string, keysAndValues ...interface{}) {
 	leveled.logger.Warn(fmt.Sprintf("%s: %+v", msg, keysAndValues))
 }
 
-// Info logs a message at info level using the wrapped zap.Logger.
+// Info logs a message at the info level using the wrapped zap.Logger.
 func (leveled LeveledLogger) Info(msg string, keysAndValues ...interface{}) {
 	leveled.logger.Info(fmt.Sprintf("%s: %+v", msg, keysAndValues))
 }
 
-// Debug logs a message at debug level using the wrapped zap.Logger.
+// Debug logs a message at the debug level using the wrapped zap.Logger.
 func (leveled LeveledLogger) Debug(msg string, keysAndValues ...interface{}) {
 	leveled.logger.Debug(fmt.Sprintf("%s: %+v", msg, keysAndValues))
 }

pkg/gotenberg/pdfengine.go

@@ -13,7 +13,7 @@ var (
 	ErrPdfEngineMethodNotSupported = errors.New("method not supported")
 
 	// ErrPdfSplitModeNotSupported is returned when the Split method of the
-	// PdfEngine interface does not sumport a requested PDF split mode.
+	// PdfEngine interface does not support a requested PDF split mode.
 	ErrPdfSplitModeNotSupported = errors.New("split mode not supported")
 
 	// ErrPdfFormatNotSupported is returned when the Convert method of the
@@ -86,7 +86,7 @@ type PdfFormats struct {
 }
 
 // PdfEngine provides an interface for operations on PDFs. Implementations
-// can utilize various tools like PDFtk, or implement functionality directly in
+// can use various tools like PDFtk, or implement functionality directly in
 // Go.
 //
 //nolint:dupl