Commit a2bbec4
committed
docs(service-cluster-redis): narrow three contract-test header sentences to the populations actually measured
Review found three sentences in the header whose stated population was wider
than the measurement behind them. All three are corrected here; the diff stays
comments-only (proved: every added and removed line is a comment line, with a
control showing the filter admits code).
1. The "no live-Redis path" parenthetical claimed both names appeared nowhere
in the package. Re-scanned the WHOLE package rather than `src/`:
`RUN_REAL_REDIS` and `skipIf` do occur nowhere outside that sentence, so the
escape hatch genuinely never existed — but `REDIS_URL` occurs at
`README.md:42`, as the env var a caller feeds to `createRedisClient()`. The
sentence now says exactly that instead of over-reaching.
2. `multi` was listed among the commands carrying their v5 overloads verbatim
into `RedisCommander.d.ts`. That is false for `multi` specifically: it is
declared there in NEITHER version (measured 0 and 0, against a control
member `exec` reading 1 and 1); it lives on `Transaction`. Measured on its
real home, it DID change — all four overloads went from returning
`ChainableCommander` to returning it parameterised by a reply mapping. It is
removed from the verbatim list and given its own bullet stating why the
change is inert here: the parameter defaults to "resp2", the class defaults
to "legacy" and extends `Transaction` at "resp2", so a client built without
`replyMapping` resolves `multi()` to the non-RESP3 instantiation.
3. "v6's one substantive change reachable from this package" was wrong in the
other direction: v6 also changes connection defaults that are NOT opt-in —
`protocol: 3` (no such option in v5) and `keepAlive` 0 to 30000. The
sentence is scoped to "the surface these suites drive", which is what was
measured, and the connection-default changes are named as
changed-but-unexercised, since no suite here calls `createRedisClient()`.
Two further wording fixes, each closing a way the note could read as true when
it is not:
- the expiry clause now also fires on a RESOLVED-version move under an
unchanged caret range, which a lockfile bump alone will do; as written it
expired only when a range moved
- the unmet-peer warning is scoped to a resolving install, since a frozen
re-link prints nothing
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01XpTx2tbq3pZRYAdoGt6E6Y1 parent 14e70d8 commit a2bbec4
1 file changed
Lines changed: 37 additions & 17 deletions
Lines changed: 37 additions & 17 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
9 | | - | |
10 | | - | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
11 | 14 | | |
12 | 15 | | |
13 | 16 | | |
14 | 17 | | |
15 | | - | |
16 | | - | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
17 | 21 | | |
18 | 22 | | |
19 | 23 | | |
20 | 24 | | |
21 | 25 | | |
22 | 26 | | |
23 | | - | |
24 | | - | |
25 | | - | |
26 | | - | |
27 | | - | |
28 | | - | |
29 | | - | |
30 | | - | |
31 | | - | |
32 | | - | |
33 | | - | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
34 | 53 | | |
35 | 54 | | |
36 | 55 | | |
37 | 56 | | |
38 | 57 | | |
39 | 58 | | |
40 | | - | |
41 | | - | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
42 | 62 | | |
43 | 63 | | |
44 | 64 | | |
| |||
0 commit comments