Skip to content

Commit 291353b

Browse files
authored
Merge pull request #19281 from AwesomePatrol/fix-kubernetes-interface-docs
Fix documentation of List method of Kubernetes interface
2 parents 2895b19 + 62bbf28 commit 291353b

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

client/v3/kubernetes/interface.go

+6-4
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,9 @@ type Interface interface {
3636
// If opts.Revision is non-zero, the key-value pairs are retrieved at the specified revision.
3737
// If the required revision has been compacted, the request will fail with ErrCompacted.
3838
// If opts.Limit is greater than zero, the number of returned key-value pairs is bounded by the limit.
39-
// If opts.Continue is not empty, the listing will start from the key immediately after the one specified by Continue.
40-
// The Continue value should be the last key returned in a previous paginated ListResponse.
39+
// If opts.Continue is not empty, the listing will start from the key
40+
// specified by it. When paginating, the Continue value should be set
41+
// to the last observed key with "\x00" appended to it.
4142
List(ctx context.Context, prefix string, opts ListOptions) (ListResponse, error)
4243

4344
// Count returns the number of keys with the specified prefix.
@@ -74,8 +75,9 @@ type ListOptions struct {
7475
// 0 means no limitation.
7576
Limit int64
7677

77-
// Continue is a key from which to resume the List operation, excluding the given key.
78-
// It should be set to the last key from a previous ListResponse when paginating.
78+
// Continue is a key from which to resume the List operation.
79+
// It should be set to the last key from a previous ListResponse
80+
// with "\x00" appended to it when paginating.
7981
Continue string
8082
}
8183

0 commit comments

Comments
 (0)