Skip to content

DOC-7267 Record the node_redis, redis_py and NRedisStack lessons in client-quirks - #4494

Merged
andy-stark-redis merged 1 commit into
mainfrom
DOC-7267-client-quirks-note
Nov 6, 2026
Merged

andy-stark-redis merged 1 commit into
mainfrom
DOC-7267-client-quirks-note

Conversation

@andy-stark-redis

@andy-stark-redis andy-stark-redis commented Nov 6, 2026 •

Copy link
Copy Markdown
Contributor

Probably didn't need to be a separate PR, TBH, but Claude thought of it and did it automatically after the other thing merged.

Summary

Promotes the durable findings from the DOC-7267 cleanup PRs (#4482, #4484, #4486) into .claude/skills/command-api-mapping/reference/client-quirks.md, so a future sweep sees them before authoring:

  • node_redis: both the uppercase and camelCase keys exist and entries use camelCase; modules are client.<namespace>.<method>; take reply types from source, not the .d.ts; how to get the sources and tsc.
  • redis_py: ten methods that raise NotImplementedError (record unsupported, don't author); resolve module methods against the class for the command prefix; how to pin a version.
  • NRedisStack: an async entry is never a copy of the sync one; the scan overloads return IAsyncEnumerable<T>; verify by reflection.

29 lines added to one reference file. No data changes.

Ticket: DOC-7267

🤖 Generated with Claude Code


Note

Low Risk
Documentation-only changes to internal reference; no runtime or data impact.

Overview
Promotes DOC-7267 lessons into client-quirks.md so future command-mapping work matches real client behavior.

node_redis: Prefer camelCase exports from index.ts (not dotted module names like BF.ADD); use client.<namespace>.<method> for modules. Derive reply types from transformReply in source (RESP2 when both exist), not expanded .d.ts; use declarations only for names/arity and tsc --strict. Adds tooling notes (gh api tarball, local npm + tsc, sandbox off).

redis_py: Documents methods that only raise NotImplementedError — leave empty signatures and mark unsupported; clarifies module classes and repeated method names; adds version pinning via pip install --target + PYTHONPATH.

nredisstack / StackExchange.Redis: Async rows are not sync copies (Async suffix, Task<T> / IAsyncEnumerable for scans with correct params); core entries omit return type in signature and put Task<T> in returns.type; verify with reflection on pinned assemblies.

go-redis: Fixes prior guidance — keep ctx context.Context in signature and params.

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

…lient-quirks

The DOC-7267 cleanup PRs (#4482, #4484, #4486) left their durable findings only in commit
bodies, where a future sweep would not see them before authoring. They now sit in the
per-client sections of the skill's quirks reference: node-redis lists every command under an
uppercase and a camelCase key and modules are client.<namespace>.<method>; reply types come
from source, not the .d.ts; ten redis-py methods raise NotImplementedError; an NRedisStack
async entry is never a copy of the sync one, and the scan overloads return IAsyncEnumerable.

Directive: when a sweep finds a client convention that is not in this file, add it here in the same PR
Ticket: DOC-7267
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Nov 6, 2026 •

Copy link
Copy Markdown
Contributor

DOC-7267

@github-actions

github-actions Bot commented Nov 6, 2026

Copy link
Copy Markdown
Contributor

🧠 Redis Memory

Found 5 related items from repository history (5 new this commit):

Memory updated at eae1eda

@andy-stark-redis
andy-stark-redis requested a review from a team November 6, 2026 10:52
@andy-stark-redis andy-stark-redis self-assigned this Nov 6, 2026
@andy-stark-redis andy-stark-redis added the clients Client library docs label Nov 6, 2026

@dwdougherty dwdougherty 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.

@andy-stark-redis
andy-stark-redis merged commit 29d83e1 into main Nov 6, 2026
109 checks passed
@andy-stark-redis
andy-stark-redis deleted the DOC-7267-client-quirks-note branch November 6, 2026 14:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

clients Client library docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants