From 3a95ec84067c85256a472e1c6ae2de0d4a4289f8 Mon Sep 17 00:00:00 2001 From: Travis Bischel Date: Mon, 10 May 2021 23:44:31 -0600 Subject: [PATCH] GroupTxnSession.End: document no error is worth retrying --- pkg/kgo/txn.go | 3 +++ 1 file changed, 3 insertions(+) diff --git a/pkg/kgo/txn.go b/pkg/kgo/txn.go index d43f209f..936367fa 100644 --- a/pkg/kgo/txn.go +++ b/pkg/kgo/txn.go @@ -145,6 +145,9 @@ func (s *GroupTransactSession) Begin() error { // in committing offsets fails, this aborts. // // This returns whether the transaction committed or any error that occurred. +// No returned error is retriable. Either the transactional ID has entered a +// failed state, or the client retried so much that the retry limit was hit, +// and odds are you should not continue. // // Note that canceling the context will likely leave the client in an // undesirable state, because canceling the context cancels in flight requests