Add missing examples for Python and Node #1227
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
shohamazon
force-pushed
the
node_add_examples
branch
from
3f1113b to
f7322cb
Compare
acarbonetto
approved these changes
Apr 3, 2024
node/src/BaseClient.ts
Outdated
| * | ||
| * @example | ||
| * ```typescript | ||
| * // Example usage of the hincrby method |
There was a problem hiding this comment.
Copy comment from incrBy - it is more verbose
node/src/BaseClient.ts
Outdated
| * | ||
| * @example | ||
| * ```typescript | ||
| * // Example usage of the hincrbyfloat method |
There was a problem hiding this comment.
Copy from incrByFloat
| * @example | ||
| * ```typescript | ||
| * // Example usage of configGet method with multiple configuration parameters | ||
| * const result = await client.configGet(["timeout", "maxmemory"]); |
There was a problem hiding this comment.
Show example with wildcard
| * connection.customCommand(["CLIENT", "LIST","TYPE", "PUBSUB"], "allPrimaries") | ||
| * ```typescript | ||
| * // Example usage of customCommand method to retrieve pub/sub clients with routing to all primary nodes | ||
| * const result = await client.customCommand(["CLIENT", "LIST", "TYPE", "PUBSUB"], "allPrimaries"); |
There was a problem hiding this comment.
Is there a constant for allPrimaries?
| @@ -238,6 +238,10 @@ async def set( | |||
| If the value is successfully set, return OK. | |||
| If value isn't set because of only_if_exists or only_if_does_not_exist conditions, return None. | |||
| If return_old_value is set, return the old value as a string. | |||
|
|
|||
| Example: | |||
| >>> await client.set("key", "value") | |||
There was a problem hiding this comment.
show options in example
| @@ -275,6 +283,13 @@ async def delete(self, keys: List[str]) -> int: | |||
|
|
|||
| Returns: | |||
| int: The number of keys that were deleted. | |||
|
|
|||
| Examples: | |||
| >>> await client.set("key", "value") | |||
There was a problem hiding this comment.
You can omit set I think
| >>> await client.delete("key") | ||
| 1 | ||
| >>> await client.delete("key") | ||
| 0 |
There was a problem hiding this comment.
Copy "Indicates ..." comments from node docs - they are pretty good
barshaul
reviewed
Apr 7, 2024
node/src/RedisClient.ts
Outdated
| * ```typescript | ||
| * // Example usage of ping method with a message | ||
| * const result = await client.ping("Hello"); | ||
| * console.log(result); // Output: "Hello" |
There was a problem hiding this comment.
minor: please be consistent with one or two quotes, here it's
// Output: "Hello"
and other places it's:
// Output: 'Connection Name'
barshaul
approved these changes
Apr 7, 2024
There was a problem hiding this comment.
Great job 🔥
Please fix @Yury-Fridlyand and @acarbonetto comments before merging.
Does it also reformat all existing typescript examples?
Co-authored-by: Andrew Carbonetto <[email protected]>
Co-authored-by: Andrew Carbonetto <[email protected]>
shohamazon
commented
Apr 7, 2024
Co-authored-by: Andrew Carbonetto <[email protected]>
Co-authored-by: Yury-Fridlyand <[email protected]>
Co-authored-by: Yury-Fridlyand <[email protected]>
Co-authored-by: Andrew Carbonetto <[email protected]>
Co-authored-by: Andrew Carbonetto <[email protected]>
Co-authored-by: Andrew Carbonetto <[email protected]>
Co-authored-by: Yury-Fridlyand <[email protected]>
Co-authored-by: Andrew Carbonetto <[email protected]>
Co-authored-by: Andrew Carbonetto <[email protected]>
Co-authored-by: Andrew Carbonetto <[email protected]>
Co-authored-by: Andrew Carbonetto <[email protected]>
Co-authored-by: Andrew Carbonetto <[email protected]>
Co-authored-by: Andrew Carbonetto <[email protected]>
Co-authored-by: Andrew Carbonetto <[email protected]>
Co-authored-by: Andrew Carbonetto <[email protected]>
Co-authored-by: Andrew Carbonetto <[email protected]>
shohamazon
added a commit
to adanWattad/glide-for-redis
that referenced
this pull request
Apr 9, 2024
This was referenced Apr 24, 2024
cyip10
pushed a commit
to Bit-Quill/valkey-glide
that referenced
this pull request
Jun 24, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue #, if available:
Description of changes:
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.