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

Adding Javadocs to Jedis 'args' package #3210

Merged
merged 6 commits into from
Dec 4, 2022

Conversation

zeekling
Copy link
Contributor

Add doc for jedis

@codecov-commenter
Copy link

codecov-commenter commented Nov 20, 2022

Codecov Report

Base: 66.90% // Head: 66.86% // Decreases project coverage by -0.03% ⚠️

Coverage data is based on head (d8f89dd) compared to base (11a4513).
Patch coverage: 100.00% of modified lines in pull request are covered.

Additional details and impacted files
@@             Coverage Diff              @@
##             master    #3210      +/-   ##
============================================
- Coverage     66.90%   66.86%   -0.04%     
+ Complexity     4546     4543       -3     
============================================
  Files           248      248              
  Lines         14738    14742       +4     
  Branches        916      916              
============================================
- Hits           9860     9857       -3     
- Misses         4487     4492       +5     
- Partials        391      393       +2     
Impacted Files Coverage Δ
.../java/redis/clients/jedis/args/BitCountOption.java 100.00% <ø> (ø)
src/main/java/redis/clients/jedis/args/BitOP.java 100.00% <ø> (ø)
...java/redis/clients/jedis/args/ClientPauseMode.java 100.00% <ø> (ø)
...edis/clients/jedis/args/ClusterFailoverOption.java 0.00% <ø> (ø)
.../java/redis/clients/jedis/args/RawableFactory.java 83.33% <ø> (ø)
...ava/redis/clients/jedis/args/ClusterResetType.java 100.00% <100.00%> (ø)
...in/java/redis/clients/jedis/args/ExpiryOption.java 100.00% <100.00%> (ø)
...ava/redis/clients/jedis/JedisClusterInfoCache.java 72.50% <0.00%> (-3.13%) ⬇️
src/main/java/redis/clients/jedis/JedisPubSub.java 70.00% <0.00%> (-1.82%) ⬇️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@chayim chayim changed the title WIP:Add doc for jedis WIP: Adding Docstrings for Jedis functions Nov 20, 2022
@@ -2,6 +2,9 @@

import redis.clients.jedis.util.SafeEncoder;

/**
* The args for the command bitcount
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
* The args for the command bitcount
* The options for {@code BITCOUNT} command.

src/main/java/redis/clients/jedis/args/BitOP.java Outdated Show resolved Hide resolved
src/main/java/redis/clients/jedis/args/ClientType.java Outdated Show resolved Hide resolved
src/main/java/redis/clients/jedis/args/RawableFactory.java Outdated Show resolved Hide resolved
src/main/java/redis/clients/jedis/args/RawableFactory.java Outdated Show resolved Hide resolved
src/main/java/redis/clients/jedis/args/Rawable.java Outdated Show resolved Hide resolved
src/main/java/redis/clients/jedis/args/Rawable.java Outdated Show resolved Hide resolved
src/main/java/redis/clients/jedis/args/Rawable.java Outdated Show resolved Hide resolved
@zeekling zeekling changed the title WIP: Adding Docstrings for Jedis functions Adding Docstrings for Jedis functions Dec 3, 2022
@sazzad16 sazzad16 added this to the 4.4.0 milestone Dec 4, 2022
@sazzad16 sazzad16 changed the title Adding Docstrings for Jedis functions Adding Javadocs to Jedis 'args' package Dec 4, 2022
@sazzad16 sazzad16 merged commit 9f029c3 into redis:master Dec 4, 2022
@zeekling zeekling deleted the jedis_doc_update branch December 6, 2022 14:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants