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

Edit and cleanup up Javadoc #2586

Open
jxblum opened this issue May 23, 2023 · 2 comments
Open

Edit and cleanup up Javadoc #2586

jxblum opened this issue May 23, 2023 · 2 comments
Assignees
Labels
type: documentation A documentation update

Comments

@jxblum
Copy link
Contributor

jxblum commented May 23, 2023

This fixes Javadoc errors and warnings in the Spring Data Redis codebase.

@jxblum jxblum self-assigned this May 23, 2023
@jxblum jxblum added the type: documentation A documentation update label May 23, 2023
jxblum added a commit to jxblum/spring-data-redis that referenced this issue May 23, 2023
@jxblum jxblum closed this as completed in 65fbe21 May 23, 2023
jxblum added a commit to jxblum/spring-data-redis that referenced this issue May 23, 2023
jxblum added a commit to jxblum/spring-data-redis that referenced this issue May 23, 2023
jxblum added a commit to jxblum/spring-data-redis that referenced this issue May 23, 2023
@jxblum
Copy link
Contributor Author

jxblum commented May 23, 2023

Re-opening for additional cleanup and editing.

@jxblum jxblum reopened this May 23, 2023
@jxblum jxblum closed this as completed in 050beeb May 23, 2023
@jxblum jxblum reopened this May 23, 2023
@jxblum jxblum closed this as completed in 433bb89 Jun 14, 2023
jxblum added a commit to jxblum/spring-data-redis that referenced this issue Jun 14, 2023
@jxblum jxblum reopened this Jun 14, 2023
jxblum added a commit to jxblum/spring-data-redis that referenced this issue Jun 26, 2023
@jxblum jxblum closed this as completed in 4637323 Jun 27, 2023
@jxblum jxblum reopened this Jun 27, 2023
@jxblum jxblum closed this as completed in d5642d9 Aug 8, 2023
@jxblum jxblum reopened this Aug 8, 2023
@jxblum
Copy link
Contributor Author

jxblum commented Nov 16, 2023

This Javadoc reference is a prime example of incomplete, broken documentation.

The Javadoc for the ListOperations.rightPushAll(key, ...) method states:

rightPushAll

Append values to key.

Parameters:
key - must not be null.

values -

Returns:
null when used in pipeline / transaction.
Since:
1.5
See Also:
[Redis Documentation: RPUSH](https://redis.io/commands/rpush)

key Javadoc is essentially useless with the @NonNullApi documentation.

values is empty, so why declare an @param tag for it; it just creates noise in the source file due to all the missing Javadoc warnings.

@return is mildly more useful and informative. Great! Returns null when used in Redis pipeline mode or in transactions. But, what does the Long value represent?

Does it represent the number of values successfully appended to the list referenced by the key?

Is it some 1 or 0 value based on success or failure?

No, it is not until I navigate to the Redis RPUSH command documentation do I learn that the value represents the size of the list after the push.

However, what happens when I don't have a Internet connection readily available? What if I am working in offline mode?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation A documentation update
Projects
None yet
Development

No branches or pull requests

1 participant