Repository navigation
docs: clarify config tables, fix typos, and align JSDoc examples - #3456
Merged
nkaradzhov merged 1 commit intoSep 18, 2026
Merged
Conversation
Collaborator
|
Thanks — accurate docs pass, verified the config claims against source. LGTM. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Checklist
npm testpass with this change (including linting)?Note
Low Risk
Docs and comment-only changes; no runtime or API behavior changes.
Overview
Documentation and JSDoc are updated so cluster and sentinel configuration matches what the client already supports, and a few doc mistakes are fixed.
Cluster (
clustering.md) and sentinel (sentinel.md) option tables now listkeyPrefix,commandOptions, andclientSideCache, with links to the shared guides. The cluster table also documentstopologyRefreshOnReconnectionAttemptStrategy. Client configuration and pool pages use relative./pool.mdlinks instead of full GitHub URLs, with small grammar fixes onisolationPoolOptionsand the pooling blurb.Command options fixes the ASAP queue typo (“to send”) and shows
timeoutinwithCommandOptionsexamples. Pool simple-usage examples callpool.ping()instead of incorrectly usingclient.In TypeScript JSDoc for
clientSideCacheon cluster and sentinel, copy that referred to “pooled mode” is corrected to cluster/sentinel semantics, and examples usecreateCluster/createSentinelwithrootNodesorsentinelRootNodesinstead of pool-only options likeminimum.Reviewed by Cursor Bugbot for commit 938e1b8. Bugbot is set up for automated code reviews on this repo. Configure here.