docs(godoc): fix a bunch of typos

pkg/modules/chromium/browser.go

@@ -211,7 +211,7 @@ func (b *chromiumBrowser) Stop(logger *zap.Logger) error {
 				logger.Debug(fmt.Sprintf("'%s' Chromium's user profile directory removed", userProfileDirPath))
 			}
 
-			// Also remove Chromium specific files in the temporary directory.
+			// Also, remove Chromium-specific files in the temporary directory.
 			err = gotenberg.GarbageCollect(logger, os.TempDir(), []string{".org.chromium.Chromium", ".com.google.Chrome"}, expirationTime)
 			if err != nil {
 				logger.Error(err.Error())
@@ -314,7 +314,7 @@ func (b *chromiumBrowser) do(ctx context.Context, logger *zap.Logger, url string
 		return errors.New("context has no deadline")
 	}
 
-	// We validate the "main" URL against our allow / deny lists.
+	// We validate the "main" URL against our allowed / deny lists.
 	err := gotenberg.FilterDeadline(b.arguments.allowList, b.arguments.denyList, url, deadline)
 	if err != nil {
 		return fmt.Errorf("filter URL: %w", err)
@@ -329,7 +329,7 @@ func (b *chromiumBrowser) do(ctx context.Context, logger *zap.Logger, url string
 	taskCtx, taskCancel := chromedp.NewContext(timeoutCtx)
 	defer taskCancel()
 
-	// We validate all others requests against our allow / deny lists.
+	// We validate all other requests against our allowed / deny lists.
 	// If a request does not pass the validation, we make it fail. It also set
 	// the extra HTTP headers, if any.
 	// See https://github.com/gotenberg/gotenberg/issues/1011.

pkg/modules/chromium/chromium.go

@@ -26,7 +26,7 @@ func init() {
 
 var (
 	// ErrInvalidEmulatedMediaType happens if the emulated media type is not
-	// "screen" nor "print". Empty value are allowed though.
+	// "screen" nor "print". Empty value is allowed, though.
 	ErrInvalidEmulatedMediaType = errors.New("invalid emulated media type")
 
 	// ErrInvalidEvaluationExpression happens if an evaluation expression
@@ -38,11 +38,11 @@ var (
 	ErrRpccMessageTooLarge = errors.New("rpcc message too large")
 
 	// ErrInvalidHttpStatusCode happens when the status code from the main page
-	// matches with one of the entry in [Options.FailOnHttpStatusCodes].
+	// matches with one of the entries in [Options.FailOnHttpStatusCodes].
 	ErrInvalidHttpStatusCode = errors.New("invalid HTTP status code")
 
 	// ErrInvalidResourceHttpStatusCode happens when the status code from one
-	// or more resources matches with one of the entry in
+	// or more resources matches with one of the entries in
 	// [Options.FailOnResourceHttpStatusCodes].
 	ErrInvalidResourceHttpStatusCode = errors.New("invalid resource HTTP status code")
 
@@ -68,11 +68,11 @@ var (
 	ErrInvalidPrinterSettings = errors.New("invalid printer settings")
 
 	// ErrPageRangesSyntaxError happens if the PdfOptions have an invalid page
-	// ranges.
+	// range.
 	ErrPageRangesSyntaxError = errors.New("page ranges syntax error")
 )
 
-// Chromium is a module which provides both an [Api] and routes for converting
+// Chromium is a module that provides both an [Api] and routes for converting
 // HTML document to PDF.
 type Chromium struct {
 	autoStart     bool
@@ -128,15 +128,15 @@ type Options struct {
 	UserAgent string
 
 	// ExtraHttpHeaders are extra HTTP headers to send by Chromium while
-	// loading he HTML document.
+	// loading the HTML document.
 	ExtraHttpHeaders []ExtraHttpHeader
 
 	// EmulatedMediaType is the media type to emulate, either "screen" or
 	// "print".
 	EmulatedMediaType string
 
-	// OmitBackground hides default white background and allows generating PDFs
-	// with transparency.
+	// OmitBackground hides the default white background and allows generating
+	// PDFs with transparency.
 	OmitBackground bool
 }
 
@@ -197,9 +197,9 @@ type PdfOptions struct {
 	// Page ranges to print, e.g., '1-5, 8, 11-13'. Empty means all pages.
 	PageRanges string
 
-	// HeaderTemplate is the HTML template of the header. It should be valid
-	// HTML  markup with following classes used to inject printing values into
-	// them:
+	// HeaderTemplate is the HTML template of the header. It should be a valid
+	// HTML markup with the following classes used to inject printing values
+	// into them:
 	// - date: formatted print date
 	// - title: document title
 	// - url: document location
@@ -338,7 +338,7 @@ type Api interface {
 	Screenshot(ctx context.Context, logger *zap.Logger, url, outputPath string, options ScreenshotOptions) error
 }
 
-// Provider is a module interface which exposes a method for creating an [Api]
+// Provider is a module interface that exposes a method for creating an [Api]
 // for other modules.
 //
 //	func (m *YourModule) Provision(ctx *gotenberg.Context) error {
@@ -473,8 +473,8 @@ func (mod *Chromium) StartupMessage() string {
 
 // Stop stops the current browser instance.
 func (mod *Chromium) Stop(ctx context.Context) error {
-	// Block until the context is done so that other module may gracefully stop
-	// before we do a shutdown.
+	// Block until the context is done so that another module may gracefully
+	// stop before we do a shutdown.
 	mod.logger.Debug("wait for the end of grace duration")
 
 	<-ctx.Done()

pkg/modules/chromium/events.go

@@ -72,10 +72,10 @@ func listenForEventRequestPaused(ctx context.Context, logger *zap.Logger, option
 
 				var extraHttpHeadersToSet []ExtraHttpHeader
 				if len(options.extraHttpHeaders) > 0 {
-					// The user want to set extra HTTP headers.
+					// The user wants to set extra HTTP headers.
 
 					// First, we have to check if at least one header has to be
-					// set for current request.
+					// set for the current request.
 					for _, header := range options.extraHttpHeaders {
 						if header.Scope == nil {
 							// Non-scoped header.
@@ -147,8 +147,8 @@ type eventResponseReceivedOptions struct {
 	invalidResourceHttpStatusCodeMu *sync.RWMutex
 }
 
-// listenForEventResponseReceived listens for an invalid HTTP status code that
-// is returned by the main page or by one or more resources.
+// listenForEventResponseReceived listens for an invalid HTTP status code
+// returned by the main page or by one or more resources.
 // See:
 // https://github.com/gotenberg/gotenberg/issues/613.
 // https://github.com/gotenberg/gotenberg/issues/1021.

pkg/modules/chromium/routes.go

@@ -25,7 +25,7 @@ import (
 )
 
 // FormDataChromiumOptions creates [Options] from the form data. Fallback to
-// default value if the considered key is not present.
+// the default value if the considered key is not present.
 func FormDataChromiumOptions(ctx *api.Context) (*api.FormData, Options) {
 	defaultOptions := DefaultOptions()
 
@@ -194,7 +194,7 @@ func FormDataChromiumOptions(ctx *api.Context) (*api.FormData, Options) {
 }
 
 // FormDataChromiumPdfOptions creates [PdfOptions] from the form data. Fallback to
-// default value if the considered key is not present.
+// the default value if the considered key is not present.
 func FormDataChromiumPdfOptions(ctx *api.Context) (*api.FormData, PdfOptions) {
 	form, options := FormDataChromiumOptions(ctx)
 	defaultPdfOptions := DefaultPdfOptions()
@@ -249,7 +249,7 @@ func FormDataChromiumPdfOptions(ctx *api.Context) (*api.FormData, PdfOptions) {
 }
 
 // FormDataChromiumScreenshotOptions creates [ScreenshotOptions] from the form
-// data. Fallback to default value if the considered key is not present.
+// data. Fallback to the default value if the considered key is not present.
 func FormDataChromiumScreenshotOptions(ctx *api.Context) (*api.FormData, ScreenshotOptions) {
 	form, options := FormDataChromiumOptions(ctx)
 	defaultScreenshotOptions := DefaultScreenshotOptions()
@@ -483,7 +483,7 @@ func convertMarkdownRoute(chromium Api, engine gotenberg.PdfEngine) api.Route {
 }
 
 // screenshotMarkdownRoute returns an [api.Route] which can take a screenshot
-// from markdown files.
+// from Markdown files.
 func screenshotMarkdownRoute(chromium Api) api.Route {
 	return api.Route{
 		Method:      http.MethodPost,
@@ -522,7 +522,7 @@ func screenshotMarkdownRoute(chromium Api) api.Route {
 }
 
 func markdownToHtml(ctx *api.Context, inputPath string, markdownPaths []string) (string, error) {
-	// We have to convert each markdown file referenced in the HTML
+	// We have to convert each Markdown file referenced in the HTML
 	// file to... HTML. Thanks to the "html/template" package, we are
 	// able to provide the "toHTML" function which the user may call
 	// directly inside the HTML file.

pkg/modules/chromium/stream.go

@@ -24,7 +24,7 @@ type streamReader struct {
 // Read a chunk of the stream.
 func (reader *streamReader) Read(p []byte) (n int, err error) {
 	if reader.r != nil {
-		// Continue reading from buffer.
+		// Continue reading from the buffer.
 		return reader.read(p)
 	}