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

Node: Clean since tags in command documentation #2111

Merged
merged 11 commits into from
Aug 15, 2024

Conversation

acarbonetto
Copy link
Collaborator

@acarbonetto acarbonetto commented Aug 9, 2024

Updates javadoc on all node commands to use @see and @remarks to help document links and remarks.

Example - see and remarks can be grouped together:

     * @see {@link https://valkey.io/commands/mget/|valkey.io} for details.
     * @remarks When in cluster mode, the command may route to multiple nodes when `keys` map to different hash slots.

multiple remarks - also the "Since" comment is updated to a @remark to format it correctly:

     * @see {@link https://valkey.io/commands/blmove/|valkey.io} for details.
     * @remarks When in cluster mode, both `source` and `destination` must map to the same hash slot.
     * @remarks `BLMOVE` is a client blocking command, see {@link https://github.com/valkey-io/valkey-glide/wiki/General-Concepts#blocking-commands|Valkey Glide Wiki} for more details and best practices.
     * @remarks Since Valkey version 6.2.0.

@acarbonetto acarbonetto requested a review from a team as a code owner August 9, 2024 22:41
@Yury-Fridlyand Yury-Fridlyand added the node Node.js wrapper label Aug 10, 2024
node/src/GlideClusterClient.ts Show resolved Hide resolved
node/src/BaseClient.ts Show resolved Hide resolved
node/src/BaseClient.ts Show resolved Hide resolved
node/src/BaseClient.ts Show resolved Hide resolved
@acarbonetto acarbonetto force-pushed the node/acarbo_cleanup_doc_since branch from 74960fd to baacf9f Compare August 14, 2024 22:00
Signed-off-by: Andrew Carbonetto <[email protected]>
Signed-off-by: Andrew Carbonetto <[email protected]>
Signed-off-by: Andrew Carbonetto <[email protected]>
Signed-off-by: Andrew Carbonetto <[email protected]>
Signed-off-by: Andrew Carbonetto <[email protected]>
Signed-off-by: Andrew Carbonetto <[email protected]>
Signed-off-by: Andrew Carbonetto <[email protected]>
@acarbonetto acarbonetto force-pushed the node/acarbo_cleanup_doc_since branch from baacf9f to bff8a6d Compare August 14, 2024 22:04
Signed-off-by: Andrew Carbonetto <[email protected]>
node/src/BaseClient.ts Outdated Show resolved Hide resolved
node/src/GlideClient.ts Outdated Show resolved Hide resolved
node/src/GlideClient.ts Outdated Show resolved Hide resolved
node/src/GlideClient.ts Show resolved Hide resolved
node/src/GlideClusterClient.ts Outdated Show resolved Hide resolved
node/src/Transaction.ts Outdated Show resolved Hide resolved
node/src/Transaction.ts Outdated Show resolved Hide resolved
node/src/Transaction.ts Outdated Show resolved Hide resolved
node/src/Transaction.ts Outdated Show resolved Hide resolved
node/src/Transaction.ts Outdated Show resolved Hide resolved
node/src/BaseClient.ts Outdated Show resolved Hide resolved
node/src/Transaction.ts Outdated Show resolved Hide resolved
node/src/BaseClient.ts Show resolved Hide resolved
node/src/Transaction.ts Show resolved Hide resolved
node/src/Transaction.ts Show resolved Hide resolved
Signed-off-by: Andrew Carbonetto <[email protected]>
Copy link
Collaborator

@Yury-Fridlyand Yury-Fridlyand left a comment

Choose a reason for hiding this comment

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

LGTM
Please downmerge main before merging the PR to ensure that you don't have missed changes.

@@ -4855,9 +4904,9 @@ export class BaseClient {
/** Estimates the cardinality of the data stored in a HyperLogLog structure for a single key or
Copy link
Collaborator

Choose a reason for hiding this comment

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

While you are updating all commands, shall we make the style consistence with others?

Suggested change
/** Estimates the cardinality of the data stored in a HyperLogLog structure for a single key or
/**
* Estimates the cardinality of the data stored in a HyperLogLog structure for a single key or

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I try - although I don't prioritize style that doesn't affect the rendered product.
So this change isn't really a must have. I like to make it consistent for the developer's sake.

Signed-off-by: Andrew Carbonetto <[email protected]>
@acarbonetto acarbonetto merged commit 65fcb42 into valkey-io:main Aug 15, 2024
8 checks passed
@acarbonetto acarbonetto deleted the node/acarbo_cleanup_doc_since branch August 15, 2024 16:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
node Node.js wrapper
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants