Skip to content

Commit

Permalink
rangefeed: improve a comment
Browse files Browse the repository at this point in the history
Release note: None
  • Loading branch information
irfansharif committed Oct 28, 2021
1 parent 82f6f2e commit fde4604
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions pkg/kv/kvclient/rangefeed/rangefeed.go
Original file line number Diff line number Diff line change
Expand Up @@ -193,8 +193,9 @@ func (f *RangeFeed) Start(ctx context.Context) error {
return nil
}

// Close closes the RangeFeed and waits for it to shut down.
// Close is idempotent.
// Close closes the RangeFeed and waits for it to shut down; it does
// idempotently. It's guaranteed that no future handlers will be invoked after
// this point.
func (f *RangeFeed) Close() {
f.closeOnce.Do(func() {
f.cancel()
Expand Down

0 comments on commit fde4604

Please sign in to comment.