twmb / franz-go

franz-go contains a feature complete, pure Go library for interacting with Kafka from 0.8.0 through 3.6+. Producing, consuming, transacting, administrating, etc.
BSD 3-Clause "New" or "Revised" License
1.6k stars 158 forks source link

Clarify kgo.RequestTimeoutOverhead() documentation #724

Closed pracucci closed 1 month ago

pracucci commented 1 month ago

I just realised that the kgo.RequestTimeoutOverhead() is the default timeout for most of the requests. I didn't understand it just reading the doc, as I thought it was always an overhead. I'm proposing a small rephrasing of the doc: does it make sense to you?