Skip to content
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

Merged
merged 3 commits into from
Feb 2, 2024
Merged

[IMPROVED] KeyValue documentation #1537

merged 3 commits into from
Feb 2, 2024

Conversation

piotrpio
Copy link
Collaborator

Signed-off-by: Piotr Piotrowski [email protected]

Signed-off-by: Piotr Piotrowski <[email protected]>
Copy link
Contributor

@ripienaar ripienaar left a 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
Copy link
Contributor

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]>
Copy link
Member

@Jarema Jarema left a 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 Show resolved Hide resolved
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
Copy link
Member

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"?

jetstream/README.md Outdated Show resolved Hide resolved
jetstream/README.md Outdated Show resolved Hide resolved
jetstream/README.md Outdated Show resolved Hide resolved
jetstream/README.md Outdated Show resolved Hide resolved
jetstream/README.md Outdated Show resolved Hide resolved
jetstream/README.md Outdated Show resolved Hide resolved
jetstream/README.md Show resolved Hide resolved
Signed-off-by: Piotr Piotrowski <[email protected]>
Copy link
Member

@Jarema Jarema left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@piotrpio piotrpio merged commit 7baddc7 into main Feb 2, 2024
1 of 2 checks passed
@piotrpio piotrpio deleted the improve-kv-docs branch February 2, 2024 14:39
@piotrpio piotrpio mentioned this pull request Feb 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants