Skip to content

Commit

Permalink
Update docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelwilner authored Jan 6, 2022
1 parent 2d67450 commit f5414b2
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions pkg/kgo/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -1323,14 +1323,14 @@ func RequireStableFetchOffsets() GroupOpt {
// after offsets are fetched for those partitions so that a user can adjust them
// before consumption begins.
//
// This function combined should not exceed the rebalance interval. It is possible
// This function should not exceed the rebalance interval. It is possible
// for the group, immediately after finishing a balance, to re-enter a new balancing
// session. This function is passed a context that is canceled if the current group
// session finishes (i.e., after revoking).
//
// If you are resetting the position of the offset, you may want to clear any existing
// "epoch" with WithEpoch(-1). If the epoch is non-negative, the client performs
// data loss detection, which may result in errors and unexpected consuming offsets.
// data loss detection, which may result in errors and unexpected behavior.
func AdjustFetchOffsetsFn(adjustOffsetsBeforeAssign func(context.Context, map[string]map[int32]Offset) (map[string]map[int32]Offset, error)) GroupOpt {
return groupOpt{func(cfg *cfg) { cfg.adjustOffsetsBeforeAssign = adjustOffsetsBeforeAssign }}
}
Expand Down

0 comments on commit f5414b2

Please sign in to comment.