Skip to content

Commit 198e37e

Browse files
ori0o0pori0o0p
authored
docs: Fix various typos in documentation (#3423)
* docs: Fix various typos in documentation Corrected several spelling and grammatical errors in the documentation. - Fixed a grammatical error in the ElastiCache link in getting-started.md. - Fixed multiple typos and grammatical errors in advanced-usage.md. * fix my mistake
1 parent c1841ed commit 198e37e

File tree

2 files changed

+14
-13
lines changed

2 files changed

+14
-13
lines changed

‎docs/advanced-usage.md‎

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -101,9 +101,10 @@ The basic configuration options are listed in the table below:
101101
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|-------------|
102102
| **I/O Thread Pool Size** | `ioThreadPoolSize` | `See below` |
103103
| The number of threads in the I/O thread pools. Every thread represents an internal event loop where all I/O tasks are run. The number does not reflect the actual number of I/O threads because the client requires different thread pools for Network (NIO) and Unix Domain Socket (EPoll) connections. The minimum I/O threads are `2`. | | |
104-
| **Computation Thread Pool Size** | `comput ationThreadPoolSize` | `See below` |
104+
| **Computation Thread Pool Size** | `computationThreadPoolSize` | `See below` |
105105
| The number of threads in the computation thread pool. Every thread represents an internal event loop where all computation tasks are run. The minimum computation threads are `2`. | | |
106106

107+
107108
#### Default thread pool size
108109

109110
Unless configured otherwise by the settings above, the number of threads (for both computation and I/O) is determined in the following order:
@@ -154,7 +155,7 @@ needs to be shut down once you no longer need the resources.</td>
154155
total control over the thread pools can provide an existing
155156
<code>EventExecutorGroup</code> to the Client resources. A provided
156157
<code>EventExecutorGroup</code> is not managed by the client and needs
157-
to be shut down once you do not longer need the resources.</td>
158+
to be shut down once you no longer need the resources.</td>
158159
</tr>
159160
<tr>
160161
<td><strong>Event bus</strong></td>
@@ -281,7 +282,7 @@ customization of <code>Bootstrap</code> after <code>Bootstrap</code>
281282
configuration by Lettuce and <code>Channel</code> customization after
282283
all Lettuce handlers are added to <code>Channel</code>. The customizer
283284
allows custom SSL configuration (requires RedisURI in plain-text mode,
284-
otherwise Lettuce’s configures SSL), adding custom handlers or setting
285+
otherwise Lettuce configures SSL), adding custom handlers or setting
285286
customized <code>Bootstrap</code> options. Misconfiguring
286287
<code>Bootstrap</code> or <code>Channel</code> can cause connection
287288
failures or undesired behavior.</p></td>
@@ -461,7 +462,7 @@ latest available protocol.</p></td>
461462
</tr>
462463
<tr>
463464
<td colspan="3"><p>Since: 6.0</p>
464-
<p>Charset to use for Luascripts.</p></td>
465+
<p>Charset to use for Lua scripts.</p></td>
465466
</tr>
466467
<tr>
467468
<td>Socket Options</td>
@@ -591,7 +592,7 @@ topology refresh. These refreshes are rate-limited using a timeout since
591592
events can happen on a large scale. Adaptive refresh triggers are
592593
disabled by default. Following triggers can be enabled:</p>
593594
<p><code>MOVED_REDIRECT</code>, <code>ASK_REDIRECT</code>,
594-
<code>PER SISTENT_RECONNECTS</code>, <code>UNKNOWN_NODE</code> (since
595+
<code>PERSISTENT_RECONNECTS</code>, <code>UNKNOWN_NODE</code> (since
595596
5.1), and <code>UNCOVERED_SLOT</code> (since 5.2) (see also reconnect
596597
attempts for the reconnect trigger)</p></td>
597598
</tr>
@@ -615,7 +616,7 @@ ignored.</p></td>
615616
</tr>
616617
<tr>
617618
<td colspan="3"><p>Since: 4.2</p>
618-
<p>Set the threshold for the <code>PE RSISTENT_RECONNECTS</code> refresh
619+
<p>Set the threshold for the <code>PERSISTENT_RECONNECTS</code> refresh
619620
trigger. Topology updates based on persistent reconnects lead only to a
620621
refresh if the reconnect process tries at least the number of specified
621622
attempts. The first reconnect attempt starts with
@@ -984,7 +985,7 @@ There are 4 StreamingChannels accepting different data types:
984985

985986
- [ScoredValueStreamingChannel](https://www.javadoc.io/static/io.lettuce/lettuce-core/6.4.0.RELEASE/io/lettuce/core/output/ScoredValueStreamingChannel.html)
986987

987-
The result of the steaming methods is the count of keys/values/key-value
988+
The result of the streaming methods is the count of keys/values/key-value
988989
pairs as `long` value.
989990

990991
!!! NOTE
@@ -1101,7 +1102,7 @@ obtaining the event bus from the client’s client resources.
11011102

11021103
``` java
11031104
RedisClient client = RedisClient.create()
1104-
EventBus eventBus = client.getresources().eventBus();
1105+
EventBus eventBus = client.getResources().eventBus();
11051106

11061107
eventBus.get().subscribe(e -> System.out.println(event));
11071108

@@ -1359,7 +1360,7 @@ The following settings are available to configure from
13591360
| **Latency percentiles** | `targetPercentiles` | `50.0, 90 .0, 95.0, 99.0, 99.9` |
13601361
| A `double`-array of percentiles for latency metrics. The `CommandMetrics` contains a map that holds the percentile value and the latency value according to the percentile. Note that percentiles here must be specified in the range between 0 and 100. | | |
13611362
| **Reset latencies after publish** | `resetLatenciesAfterEvent` | `true` |
1362-
| Allows controlling whether the latency metrics are reset to zero one they were published. Setting `resetLatenciesAfterEvent` allows accumulating metrics over a long period for long-term analytics. | | |
1363+
| Allows controlling whether the latency metrics are reset to zero once they were published. Setting `resetLatenciesAfterEvent` allows accumulating metrics over a long period for long-term analytics. | | |
13631364
| **Local socket distinction** | `localDistinction` | `false` |
13641365
| Enables per connection metrics tracking instead of per host/port. If `true`, multiple connections to the same host/connection point will be recorded separately which allows to inspection of every connection individually. If `false`, multiple connections to the same host/connection point will be recorded together. This allows a consolidated view on one particular service. | | |
13651366

@@ -1434,7 +1435,7 @@ The following settings are available to configure from
14341435
| Sets the minimum value that this timer is expected to observe. Applies only if Histogram publishing is enabled. | | |
14351436
| **Additional Tags** | `tags` | `Tags.empty()` |
14361437
| Extra tags to add to the generated metrics. | | |
1437-
| **Latency percentiles** | `targetPercentiles` | `0.5, 0.9, 0.95, 0.99, 0.999 (corresp onding with 50.0, 90. 0, 95.0, 99.0, 99.9)` |
1438+
| **Latency percentiles** | `targetPercentiles` | `0.5, 0.9, 0.95, 0.99, 0.999 (corresponding with 50.0, 90.0, 95.0, 99.0, 99.9)` |
14381439
| A `double`-array of percentiles for latency metrics. Values must be supplied in the range of `0.0` (0th percentile) up to `1.0` (100th percentile). The `CommandMetrics` contains a map that holds the percentile value and the latency value according to the percentile. This applies only if Histogram publishing is enabled. | | |
14391440

14401441
### Tracing
@@ -2099,7 +2100,7 @@ that extends `CompleteableFuture`. `AsyncCommand` can be synchronized by
20992100
`await()` or `get()` which corresponds with the asynchronous pull style.
21002101
By using the methods from the `CompletionStage` interface (such as
21012102
`handle()` or `thenAccept()`) the response handler will trigger the
2102-
functions ("listeners") on command completion. Lear more about
2103+
functions ("listeners") on command completion. Learn more about
21032104
asynchronous usage in the [Asynchronous API](user-guide/async-api.md) topic.
21042105

21052106
``` java
@@ -2617,7 +2618,7 @@ To change into *at-most-once* consistency level, disable auto-reconnect
26172618
mode. Connections can no longer be reconnected and thus no retries are
26182619
issued. Unsuccessful commands are canceled. New commands are rejected.
26192620

2620-
#### Controlling replay of commands in *at-lease-once* mode
2621+
#### Controlling replay of commands in *at-least-once* mode
26212622

26222623
!!! NOTE
26232624
This feature is only available since Lettuce 6.6

‎docs/getting-started.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ Do you want to see working examples?
7979

8080
- [Redis Cluster](https://github.com/redis/lettuce/blob/main/src/test/java/io/lettuce/examples/ConnectToRedisCluster.java)
8181

82-
- [Connecting to a ElastiCache Master](https://github.com/redis/lettuce/blob/main/src/test/java/io/lettuce/examples/ConnectToElastiCacheMaster.java)
82+
- [Connecting to the ElastiCache Master](https://github.com/redis/lettuce/blob/main/src/test/java/io/lettuce/examples/ConnectToElastiCacheMaster.java)
8383

8484
- [Connecting to ElastiCache with Master/Replica](https://github.com/redis/lettuce/blob/main/src/test/java/io/lettuce/examples/ConnectToMasterSlaveUsingElastiCacheCluster.java)
8585

0 commit comments

Comments
 (0)