chore: minor godoc refactoring

This commit is contained in:
Julien Neuhart
2023-11-19 15:02:41 +01:00
parent 5c56317d50
commit 4d1a569269
14 changed files with 51 additions and 51 deletions

View File

@@ -111,8 +111,8 @@ func (c client) send(body io.Reader, headers map[string]string, erroed bool) err
return nil
}
// leveledLogger is wrapper around a zap.Logger which is used by the
// retryablehttp.Client.
// leveledLogger is wrapper around a [zap.Logger] which is used by the
// [retryablehttp.Client].
type leveledLogger struct {
logger *zap.Logger
}

View File

@@ -549,7 +549,7 @@ func TestWebhookMiddlewareAsynchronousProcess(t *testing.T) {
}()
err := webhookMiddleware(tc.mod).Handler(tc.next)(c)
if err != nil && err != api.ErrAsyncProcess {
if err != nil && !errors.Is(err, api.ErrAsyncProcess) {
t.Errorf("test %d: expected no error but got: %v", i, err)
}

View File

@@ -30,7 +30,7 @@ type Webhook struct {
disable bool
}
// Descriptor returns an Webhook's module descriptor.
// Descriptor returns an [Webhook]'s module descriptor.
func (Webhook) Descriptor() gotenberg.ModuleDescriptor {
return gotenberg.ModuleDescriptor{
ID: "webhook",