-
Notifications
You must be signed in to change notification settings - Fork 698
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[IMPROVED] KeyValue documentation #1537
Conversation
Signed-off-by: Piotr Piotrowski <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM except for one question
Get(ctx context.Context, key string) (KeyValueEntry, error) | ||
// GetRevision returns a specific revision value for the key. | ||
|
||
// GetRevision returns a specific revision value for the key. If the key |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
also if the revision isnt found?
Signed-off-by: Piotr Piotrowski <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great addition!
Some comments and suggestions. I know you explain those mentioned ones clearly in the methods/interfaces names, but still, might be good to improve.
jetstream/README.md
Outdated
fmt.Printf("%s @ %d -> %q\n", entry.Key(), entry.Revision(), string(entry.Value())) | ||
|
||
// Update a value for a given key | ||
// Update will fail if the key does not exist or the revision is not up to date |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
hm, "or the revision changed"?
Signed-off-by: Piotr Piotrowski <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
Signed-off-by: Piotr Piotrowski [email protected]