The javadoc of return types for each methods in redis client ValueCommand.java and ReactiveValueCommands.java is inversed for some commands

[machi1990]

Description

• The ValueCommands.java method are blocking and do not return a Uni<Type> but they are documented as if they return a Uni. Example

  quarkus/extensions/redis-client/runtime/src/main/java/io/quarkus/redis/datasource/value/ValueCommands.java

  Line 222 in bd15a0b

  * @return a Uni producing a {@code null} item on success, a failure otherwise

• The ReactiveValueCommands.hava methods are non blocking and return a Uni<Type> but they are documented as if they do not return a Uni. For example

  quarkus/extensions/redis-client/runtime/src/main/java/io/quarkus/redis/datasource/value/ReactiveTransactionalValueCommands.java

  Line 288 in bd15a0b

  * @param value the value

This can be confusing to the user and it'll be good to update the javadoc for each of the methods that have a wrong return type documented.

Implementation ideas

No response

[quarkus-bot]

/cc @cescoffier (redis), @gsmet (redis)

[pernelkanic]

Can i take up this issue?

[machi1990]

Hey @pernelkanic yes please. You'll need to go through each of the methods in the above mentioned interfaces and check if the javadoc is up to accurate for the return type. If not, it'll need to be updated; so it's not only for the cited methods but all the methods in the two interfaces. Let us know if you'll need any help.

[Troll-of-Jom]

Hey @machi1990 I didn't got Second issue you have regarding "ReactiveValueCommands.java" . Means we have to make changes in the documentation, as which ever method, returns a "Uni" value should be documented as it returns a "Uni" value in the documentation. Right? this is what your issue is with the documentation of "ReactiveValueCommands.java" File?

[machi1990]

Hey @Troll-of-Jom that's correct.

[Troll-of-Jom]

@machi1990
And also what is exactly a "Uni" return type I did not get that. Means Normally we have datatypes, object type, etc as return types what is "Uni" return type?
Also when I executed the methods on redis website using the link given for each method in the documentation they do return according to how they are documented (in the "ReactiveValueCommands.java" File).
This all things I am talking about is regarding "ReactiveValueCommands.java" File only.

[Troll-of-Jom]

@machi1990 And also what is exactly a "Uni" return type I did not get that. Means Normally we have datatypes, object type, etc as return types what is "Uni" return type? Also when I executed the methods on redis website using the link given for each method in the documentation they do return according to how they are documented. This all things I am talking about is regarding "ReactiveValueCommands.java" File only.

So do I have to make changes in the second file documentation "ReactiveValueCommands.java" or not? I am a bit confused.

[machi1990]

@machi1990 And also what is exactly a "Uni" return type I did not get that.

There is no need to document what is a Uni datatype. Reactive users are already (or expected to already) be familiar with it;
For info on what is a Uni - checkout https://javadoc.io/doc/io.smallrye.reactive/mutiny/latest/io.smallrye.mutiny/io/smallrye/mutiny/Uni.html

So do I have to make changes in the second file documentation "ReactiveValueCommands.java" or not? I am a bit confused.

Thanks for the interest in contributing. Please note that, @pernelkanic already expressed interest in progressing this issue. You'll need to look for another issue or wait until @pernelkanic does get back or explicitely wants the issue unassigned

[Troll-of-Jom]

@machi1990 And also what is exactly a "Uni" return type I did not get that.

There is no need to document what is a Uni datatype. Reactive users are already (or expected to already) be familiar with it; For info on what is a Uni - checkout https://javadoc.io/doc/io.smallrye.reactive/mutiny/latest/io.smallrye.mutiny/io/smallrye/mutiny/Uni.html

So do I have to make changes in the second file documentation "ReactiveValueCommands.java" or not? I am a bit confused.

Thanks for the interest in contributing. Please note that, @pernelkanic already expressed interest in progressing this issue. You'll need to look for another issue or wait until @pernelkanic does get back or explicitely wants the issue unassigned

Ok. Will check out what is Uni.
Also I will wait until @pernelkanic responds. If he is unassigned from this issue please consider me to assign this issue.

[pernelkanic]

I replaced correct return type with methods that needs to be changed. Please review the changes.