Fixed few typos and grammar issues across the project (#3497)

as title says, few more minor typo and grammar issues I have found while was reading the code also, pom.xml links have been updated, as license link is not valid after #3496 --- Signed-off-by: Sergii Dotsenko <[email protected]> Co-authored-by: Sergii Dotsenko <[email protected]>
redis · Aug 11, 2023 · 5792218 · 5792218
1 parent ba63cf2
commit 5792218
Show file tree

Hide file tree

Showing 16 changed files with 69 additions and 69 deletions.
diff --git a/README.md b/README.md
@@ -30,10 +30,10 @@ The most recent version of this library supports redis version [5.0](https://git
 The table below highlights version compatibility of the most-recent library versions and Redis versions. Compatibility means communication features, and Redis command capabilities.
 
 
-| Library version | Supported redis versions | JDK Compatibility  |
-|-----------------|-------------------|-------------------|
-| 3.9+ | 5.0 and 6.2 Family of releases | 8, 11 |
-| >= 4.0 | Version 5.0 to current | 8, 11, 17 |
+| Library version | Supported redis versions       | JDK Compatibility |
+|-----------------|--------------------------------|-------------------|
+| 3.9+            | 5.0 and 6.2 Family of releases | 8, 11             |
+| >= 4.0          | Version 5.0 to current         | 8, 11, 17         |
 
 ## Getting started
 

diff --git a/docs/failover.md b/docs/failover.md
@@ -152,7 +152,7 @@ FailoverReporter reporter = new FailoverReporter();
 provider.setClusterFailoverPostProcessor(reporter);
 ```
 
-The provider will call your `accept` whenver a faoliver occurs.
+The provider will call your `accept` whenever a faoliver occurs.
 
 ## Failing back
 

diff --git a/pom.xml b/pom.xml
@@ -19,22 +19,22 @@
 			<name>Jedis Mailing List</name>
 			<post>[email protected]</post>
 			<archive>
-				http://groups.google.com/group/jedis_redis
+				https://groups.google.com/group/jedis_redis
 			</archive>
 		</mailingList>
 	</mailingLists>
 
 	<licenses>
 		<license>
 			<name>MIT</name>
-			<url>http://github.com/redis/jedis/raw/master/LICENSE.txt</url>
+			<url>https://github.com/redis/jedis/blob/master/LICENSE</url>
 			<distribution>repo</distribution>
 		</license>
 	</licenses>
 
 	<issueManagement>
 		<system>github</system>
-		<url>http://github.com/redis/jedis/issues</url>
+		<url>https://github.com/redis/jedis/issues</url>
 	</issueManagement>
 
 	<scm>

diff --git a/src/main/java/redis/clients/jedis/Jedis.java b/src/main/java/redis/clients/jedis/Jedis.java
@@ -352,7 +352,7 @@ public byte[] ping(final byte[] message) {
 
   /**
    * Select the DB with having the specified zero-based numeric index. For default every new
-   * connection connection is automatically selected to DB 0.
+   * connection is automatically selected to DB 0.
    * @param index
    * @return OK
    */
@@ -569,7 +569,7 @@ public long del(final byte[] key) {
 
   /**
    * This command is very similar to DEL: it removes the specified keys. Just like DEL a key is
-   * ignored if it does not exist. However the command performs the actual memory reclaiming in a
+   * ignored if it does not exist. However, the command performs the actual memory reclaiming in a
    * different thread, so it is not blocking, while DEL is. This is where the command name comes
    * from: the command just unlinks the keys from the keyspace. The actual removal will happen later
    * asynchronously.
@@ -925,7 +925,7 @@ public String setex(final byte[] key, final long seconds, final byte[] value) {
   }
 
   /**
-   * Set the the respective keys to the respective values. MSET will replace old values with new
+   * Set the respective keys to the respective values. MSET will replace old values with new
    * values, while {@link Jedis#msetnx(byte[][]) MSETNX} will not perform any operation at all even
    * if just a single key already exists.
    * <p>
@@ -973,10 +973,10 @@ public long msetnx(final byte[]... keysvalues) {
    * DECRBY work just like {@link Jedis#decr(byte[]) DECR} but instead to decrement by 1 the
    * decrement is integer.
    * <p>
-   * DECR commands are limited to 64 bit signed integers.
+   * DECR commands are limited to 64-bit signed integers.
    * <p>
    * Note: this is actually a string operation, that is, in Redis there are not "integer" types.
-   * Simply the string stored at the key is parsed as a base 10 64 bit signed integer, incremented,
+   * Simply the string stored at the key is parsed as a base 10 64-bit signed integer, incremented,
    * and then converted back as a string.
    * <p>
    * Time complexity: O(1)
@@ -997,10 +997,10 @@ public long decrBy(final byte[] key, final long decrement) {
    * Decrement the number stored at key by one. If the key does not exist or contains a value of a
    * wrong type, set the key to the value of "0" before to perform the decrement operation.
    * <p>
-   * DECR commands are limited to 64 bit signed integers.
+   * DECR commands are limited to 64-bit signed integers.
    * <p>
    * Note: this is actually a string operation, that is, in Redis there are not "integer" types.
-   * Simply the string stored at the key is parsed as a base 10 64 bit signed integer, incremented,
+   * Simply the string stored at the key is parsed as a base 10 64-bit signed integer, incremented,
    * and then converted back as a string.
    * <p>
    * Time complexity: O(1)
@@ -1020,10 +1020,10 @@ public long decr(final byte[] key) {
    * INCRBY work just like {@link Jedis#incr(byte[]) INCR} but instead to increment by 1 the
    * increment is integer.
    * <p>
-   * INCR commands are limited to 64 bit signed integers.
+   * INCR commands are limited to 64-bit signed integers.
    * <p>
    * Note: this is actually a string operation, that is, in Redis there are not "integer" types.
-   * Simply the string stored at the key is parsed as a base 10 64 bit signed integer, incremented,
+   * Simply the string stored at the key is parsed as a base 10 64-bit signed integer, incremented,
    * and then converted back as a string.
    * <p>
    * Time complexity: O(1)
@@ -1069,10 +1069,10 @@ public double incrByFloat(final byte[] key, final double increment) {
    * Increment the number stored at key by one. If the key does not exist or contains a value of a
    * wrong type, set the key to the value of "0" before to perform the increment operation.
    * <p>
-   * INCR commands are limited to 64 bit signed integers.
+   * INCR commands are limited to 64-bit signed integers.
    * <p>
    * Note: this is actually a string operation, that is, in Redis there are not "integer" types.
-   * Simply the string stored at the key is parsed as a base 10 64 bit signed integer, incremented,
+   * Simply the string stored at the key is parsed as a base 10 64-bit signed integer, incremented,
    * and then converted back as a string.
    * <p>
    * Time complexity: O(1)
@@ -1222,7 +1222,7 @@ public List<byte[]> hmget(final byte[] key, final byte[]... fields) {
    * before applying the operation. Since the value argument is signed you can use this command to
    * perform both increments and decrements.
    * <p>
-   * The range of values supported by HINCRBY is limited to 64 bit signed integers.
+   * The range of values supported by HINCRBY is limited to 64-bit signed integers.
    * <p>
    * <b>Time complexity:</b> O(1)
    * @param key
@@ -2646,7 +2646,7 @@ public KeyValue<byte[], Tuple> bzpopmin(final double timeout, final byte[]... ke
    * instructed to require a password before to allow clients to issue commands. This is done using
    * the requirepass directive in the Redis configuration file. If the password given by the connection
    * is correct the server replies with an OK status code reply and starts accepting commands from
-   * the connection. Otherwise an error is returned and the clients needs to try a new password. Note
+   * the connection. Otherwise, an error is returned and the clients needs to try a new password. Note
    * that for the high performance nature of Redis it is possible to try a lot of passwords in
    * parallel in very short time, so make sure to generate a strong and very long password so that
    * this attack is infeasible.
@@ -3617,9 +3617,9 @@ public String configResetStat() {
    * </ul>
    * <p>
    * CONFIG REWRITE is also able to rewrite the configuration file from scratch if the original one
-   * no longer exists for some reason. However if the server was started without a configuration
+   * no longer exists for some reason. However, if the server was started without a configuration
    * file at all, the CONFIG REWRITE will just return an error.
-   * @return OK when the configuration was rewritten properly. Otherwise an error is returned.
+   * @return OK when the configuration was rewritten properly. Otherwise, an error is returned.
    */
   @Override
   public String configRewrite() {
@@ -5002,7 +5002,7 @@ public long del(final String key) {
 
   /**
    * This command is very similar to DEL: it removes the specified keys. Just like DEL a key is
-   * ignored if it does not exist. However the command performs the actual memory reclaiming in a
+   * ignored if it does not exist. However, the command performs the actual memory reclaiming in a
    * different thread, so it is not blocking, while DEL is. This is where the command name comes
    * from: the command just unlinks the keys from the keyspace. The actual removal will happen later
    * asynchronously.
@@ -5362,7 +5362,7 @@ public String setex(final String key, final long seconds, final String value) {
   }
 
   /**
-   * Set the the respective keys to the respective values. MSET will replace old values with new
+   * Set the respective keys to the respective values. MSET will replace old values with new
    * values, while {@link Jedis#msetnx(String...) MSETNX} will not perform any operation at all even
    * if just a single key already exists.
    * <p>
@@ -5384,7 +5384,7 @@ public String mset(final String... keysvalues) {
   }
 
   /**
-   * Set the the respective keys to the respective values. {@link Jedis#mset(String...) MSET} will
+   * Set the respective keys to the respective values. {@link Jedis#mset(String...) MSET} will
    * replace old values with new values, while MSETNX will not perform any operation at all even if
    * just a single key already exists.
    * <p>
@@ -5409,10 +5409,10 @@ public long msetnx(final String... keysvalues) {
    * IDECRBY work just like {@link Jedis#decr(String) INCR} but instead to decrement by 1 the
    * decrement is integer.
    * <p>
-   * INCR commands are limited to 64 bit signed integers.
+   * INCR commands are limited to 64-bit signed integers.
    * <p>
    * Note: this is actually a string operation, that is, in Redis there are not "integer" types.
-   * Simply the string stored at the key is parsed as a base 10 64 bit signed integer, incremented,
+   * Simply the string stored at the key is parsed as a base 10 64-bit signed integer, incremented,
    * and then converted back as a string.
    * <p>
    * Time complexity: O(1)
@@ -5433,10 +5433,10 @@ public long decrBy(final String key, final long decrement) {
    * Decrement the number stored at key by one. If the key does not exist or contains a value of a
    * wrong type, set the key to the value of "0" before to perform the decrement operation.
    * <p>
-   * INCR commands are limited to 64 bit signed integers.
+   * INCR commands are limited to 64-bit signed integers.
    * <p>
    * Note: this is actually a string operation, that is, in Redis there are not "integer" types.
-   * Simply the string stored at the key is parsed as a base 10 64 bit signed integer, incremented,
+   * Simply the string stored at the key is parsed as a base 10 64-bit signed integer, incremented,
    * and then converted back as a string.
    * <p>
    * Time complexity: O(1)
@@ -5456,10 +5456,10 @@ public long decr(final String key) {
    * INCRBY work just like {@link Jedis#incr(String) INCR} but instead to increment by 1 the
    * increment is integer.
    * <p>
-   * INCR commands are limited to 64 bit signed integers.
+   * INCR commands are limited to 64-bit signed integers.
    * <p>
    * Note: this is actually a string operation, that is, in Redis there are not "integer" types.
-   * Simply the string stored at the key is parsed as a base 10 64 bit signed integer, incremented,
+   * Simply the string stored at the key is parsed as a base 10 64-bit signed integer, incremented,
    * and then converted back as a string.
    * <p>
    * Time complexity: O(1)
@@ -5501,10 +5501,10 @@ public double incrByFloat(final String key, final double increment) {
    * Increment the number stored at key by one. If the key does not exist or contains a value of a
    * wrong type, set the key to the value of "0" before to perform the increment operation.
    * <p>
-   * INCR commands are limited to 64 bit signed integers.
+   * INCR commands are limited to 64-bit signed integers.
    * <p>
    * Note: this is actually a string operation, that is, in Redis there are not "integer" types.
-   * Simply the string stored at the key is parsed as a base 10 64 bit signed integer, incremented,
+   * Simply the string stored at the key is parsed as a base 10 64-bit signed integer, incremented,
    * and then converted back as a string.
    * <p>
    * Time complexity: O(1)
@@ -5654,7 +5654,7 @@ public List<String> hmget(final String key, final String... fields) {
    * before applying the operation. Since the value argument is signed you can use this command to
    * perform both increments and decrements.
    * <p>
-   * The range of values supported by HINCRBY is limited to 64 bit signed integers.
+   * The range of values supported by HINCRBY is limited to 64-bit signed integers.
    * <p>
    * <b>Time complexity:</b> O(1)
    * @param key

diff --git a/src/main/java/redis/clients/jedis/JedisSentinelPool.java b/src/main/java/redis/clients/jedis/JedisSentinelPool.java
@@ -31,8 +31,8 @@ public class JedisSentinelPool extends Pool<Jedis> {
   private final Object initPoolLock = new Object();
 
   public JedisSentinelPool(String masterName, Set<HostAndPort> sentinels,
-      final JedisClientConfig masteClientConfig, final JedisClientConfig sentinelClientConfig) {
-    this(masterName, sentinels, new JedisFactory(masteClientConfig), sentinelClientConfig);
+      final JedisClientConfig masterClientConfig, final JedisClientConfig sentinelClientConfig) {
+    this(masterName, sentinels, new JedisFactory(masterClientConfig), sentinelClientConfig);
   }
 
   public JedisSentinelPool(String masterName, Set<String> sentinels,
@@ -167,9 +167,9 @@ public JedisSentinelPool(String masterName, Set<String> sentinels,
   }
 
   public JedisSentinelPool(String masterName, Set<HostAndPort> sentinels,
-      final GenericObjectPoolConfig<Jedis> poolConfig, final JedisClientConfig masteClientConfig,
+      final GenericObjectPoolConfig<Jedis> poolConfig, final JedisClientConfig masterClientConfig,
       final JedisClientConfig sentinelClientConfig) {
-    this(masterName, sentinels, poolConfig, new JedisFactory(masteClientConfig), sentinelClientConfig);
+    this(masterName, sentinels, poolConfig, new JedisFactory(masterClientConfig), sentinelClientConfig);
   }
 
   public JedisSentinelPool(String masterName, Set<HostAndPort> sentinels,

diff --git a/src/main/java/redis/clients/jedis/commands/ClientBinaryCommands.java b/src/main/java/redis/clients/jedis/commands/ClientBinaryCommands.java
@@ -46,23 +46,23 @@ public interface ClientBinaryCommands {
 
   /**
    * Returns information and statistics about the client connections server
-   * in a mostly human readable format.
+   * in a mostly human-readable format.
    *
    * @return All clients info connected to redis-server
    */
   byte[] clientListBinary();
 
   /**
    * Returns information and statistics about the client connections server
-   * in a mostly human readable format filter by client type.
+   * in a mostly human-readable format filter by client type.
    *
    * @return all clients info connected to redis-server
    */
   byte[] clientListBinary(ClientType type);
 
   /**
    * Returns information and statistics about the client connections server
-   * in a mostly human readable format filter by client ids.
+   * in a mostly human-readable format filter by client ids.
    *
    * @param clientIds Unique 64-bit client IDs
    * @return All clients info connected to redis-server
@@ -71,7 +71,7 @@ public interface ClientBinaryCommands {
 
   /**
    * Returns information and statistics about the current client connection
-   * in a mostly human readable format.
+   * in a mostly human-readable format.
    *
    * @return Information and statistics about the current client connection
    */

diff --git a/src/main/java/redis/clients/jedis/commands/ClientCommands.java b/src/main/java/redis/clients/jedis/commands/ClientCommands.java
@@ -46,23 +46,23 @@ public interface ClientCommands {
 
   /**
    * Returns information and statistics about the client connections server
-   * in a mostly human readable format.
+   * in a mostly human-readable format.
    *
    * @return All clients info connected to redis-server
    */
   String clientList();
 
   /**
    * Returns information and statistics about the client connections server
-   * in a mostly human readable format filter by client type.
+   * in a mostly human-readable format filter by client type.
    *
    * @return All clients info connected to redis-server
    */
   String clientList(ClientType type);
 
   /**
    * Returns information and statistics about the client connections server
-   * in a mostly human readable format filter by client ids.
+   * in a mostly human-readable format filter by client ids.
    *
    * @param clientIds Unique 64-bit client IDs
    * @return All clients info connected to redis-server
@@ -71,7 +71,7 @@ public interface ClientCommands {
 
   /**
    * Returns information and statistics about the current client connection
-   * in a mostly human readable format.
+   * in a mostly human-readable format.
    *
    * @return Information and statistics about the current client connection
    */

diff --git a/src/main/java/redis/clients/jedis/commands/ClusterCommands.java b/src/main/java/redis/clients/jedis/commands/ClusterCommands.java
@@ -108,15 +108,15 @@ public interface ClusterCommands {
    * Takes a list of slot ranges (specified by start and end slots) to assign to the node
    *
    * @param ranges slots range
-   * @return OK if the command was successful. Otherwise an error is returned.
+   * @return OK if the command was successful. Otherwise, an error is returned.
    */
   String clusterAddSlotsRange(int... ranges);
 
   /**
    * Takes a list of slot ranges (specified by start and end slots) to remove to the node.
    *
    * @param ranges slots range
-   * @return OK if the command was successful. Otherwise an error is returned.
+   * @return OK if the command was successful. Otherwise, an error is returned.
    */
   String clusterDelSlotsRange(int... ranges);
 }
diff --git a/src/main/java/redis/clients/jedis/commands/StreamCommands.java b/src/main/java/redis/clients/jedis/commands/StreamCommands.java
@@ -226,7 +226,7 @@ Map.Entry<StreamEntryID, List<StreamEntryID>> xautoclaimJustId(String key, Strin
    * @param key Stream name
    * @param group Group name
    * @return List of {@link StreamConsumersInfo} containing information about consumers that belong
-   * to the the group
+   * to the group
    * @deprecated Use {@link #xinfoConsumers2(java.lang.String, java.lang.String)}.
    */
   @Deprecated // keep it till at least Jedis 6/7
@@ -237,7 +237,7 @@ Map.Entry<StreamEntryID, List<StreamEntryID>> xautoclaimJustId(String key, Strin
    * @param key Stream name
    * @param group Group name
    * @return List of {@link StreamConsumerInfo} containing information about consumers that belong
-   * to the the group
+   * to the group
    */
   List<StreamConsumerInfo> xinfoConsumers2(String key, String group);
 

diff --git a/src/main/java/redis/clients/jedis/commands/StreamPipelineCommands.java b/src/main/java/redis/clients/jedis/commands/StreamPipelineCommands.java
@@ -219,7 +219,7 @@ Response<Map.Entry<StreamEntryID, List<StreamEntryID>>> xautoclaimJustId(String
    * @param key Stream name
    * @param group Group name
    * @return List of {@link StreamConsumersInfo} containing information about consumers that belong
-   * to the the group
+   * to the group
    * @deprecated Use {@link #xinfoConsumers2(java.lang.String, java.lang.String)}.
    */
   @Deprecated // keep it till at least Jedis 6/7
@@ -230,7 +230,7 @@ Response<Map.Entry<StreamEntryID, List<StreamEntryID>>> xautoclaimJustId(String
    * @param key Stream name
    * @param group Group name
    * @return List of {@link StreamConsumerInfo} containing information about consumers that belong
-   * to the the group
+   * to the group
    */
   Response<List<StreamConsumerInfo>> xinfoConsumers2(String key, String group);