← 输入框|github.com|刷新
Skip to content

docs: clarify config tables, fix typos, and align JSDoc examples - #3456

Merged
nkaradzhov merged 1 commit into
redis:masterfrom
codeXsidd:docs/clarify-config-and-fix-typos
Sep 18, 2026
Merged

nkaradzhov merged 1 commit into
redis:masterfrom
codeXsidd:docs/clarify-config-and-fix-typos

Conversation

@codeXsidd

@codeXsidd codeXsidd commented Sep 17, 2026 •

Copy link
Copy Markdown
Contributor

Description

Describe your pull request here


Checklist

  • Does npm test pass with this change (including linting)?
  • Is the new or changed code fully tested?
  • Is a documentation update included (if this change modifies existing APIs, or introduces new ones)?

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 list keyPrefix, commandOptions, and clientSideCache, with links to the shared guides. The cluster table also documents topologyRefreshOnReconnectionAttemptStrategy. Client configuration and pool pages use relative ./pool.md links instead of full GitHub URLs, with small grammar fixes on isolationPoolOptions and the pooling blurb.

Command options fixes the ASAP queue typo (“to send”) and shows timeout in withCommandOptions examples. Pool simple-usage examples call pool.ping() instead of incorrectly using client.

In TypeScript JSDoc for clientSideCache on cluster and sentinel, copy that referred to “pooled mode” is corrected to cluster/sentinel semantics, and examples use createCluster / createSentinel with rootNodes or sentinelRootNodes instead of pool-only options like minimum.

Reviewed by Cursor Bugbot for commit 938e1b8. Bugbot is set up for automated code reviews on this repo. Configure here.

Copilot AI lite review requested due to automatic review settings September 17, 2026 14:04

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@nkaradzhov

Copy link
Copy Markdown
Collaborator

Thanks — accurate docs pass, verified the config claims against source. LGTM.

@nkaradzhov nkaradzhov left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM

@nkaradzhov
nkaradzhov merged commit b218574 into redis:master Sep 18, 2026
27 of 28 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants