-
Notifications
You must be signed in to change notification settings - Fork 62
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
Node: Clean since
tags in command documentation
#2111
Conversation
74960fd
to
baacf9f
Compare
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]>
Signed-off-by: Andrew Carbonetto <[email protected]>
baacf9f
to
bff8a6d
Compare
Signed-off-by: Andrew Carbonetto <[email protected]>
Signed-off-by: Andrew Carbonetto <[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
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 |
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.
While you are updating all commands, shall we make the style consistence with others?
/** 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 |
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.
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]>
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:
multiple remarks - also the "Since" comment is updated to a
@remark
to format it correctly: