From cf530a127a10044b22b8b2d95cdcfae7631a7f27 Mon Sep 17 00:00:00 2001 From: Marco Pracucci Date: Thu, 9 May 2024 13:12:54 +0200 Subject: [PATCH] Clarify kgo.RequestTimeoutOverhead() documentation Signed-off-by: Marco Pracucci --- pkg/kgo/config.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pkg/kgo/config.go b/pkg/kgo/config.go index b63ae9d6..9d9751ef 100644 --- a/pkg/kgo/config.go +++ b/pkg/kgo/config.go @@ -571,7 +571,7 @@ func WithLogger(l Logger) Opt { // RequestTimeoutOverhead uses the given time as overhead while deadlining // requests, overriding the default overhead of 10s. // -// For most requests, the overhead will simply be this timeout. However, for +// For most requests, the timeout is set to the overhead. However, for // any request with a TimeoutMillis field, the overhead is added on top of the // request's TimeoutMillis. This ensures that we give Kafka enough time to // actually process the request given the timeout, while still having a