Commit e9600e9
fix(docs): drop porting-process jargon from stripControlChars' public doc comment
65a1a1c renamed the parameter to `eventDict` and explained WHY in the shipped
doc comment — naming the enumerator, the camelCase->snake_case fold, the rename
table, and "the oracle". The nightly PUBLIC-JARGON gate caught the last of those:
src/Logger.ts:237: banned public-doc jargon 'oracle'
[public-jargon] typescript: 1 jargon leak(s) in 1 file(s)
It is a nightly-tier gate, which is why the per-PR run-ci was green locally.
The gate is right, and not only about the one banned word. An SDK consumer reading
`stripControlChars` in their editor does not have a porting matrix, an enumerator,
or a reference oracle; every sentence of that paragraph described OUR process, not
what the parameter is or does. That reasoning belongs in the commit that made the
decision (65a1a1c, where it still is), not in shipped API documentation.
The parameter description is now what a caller needs: the log event record whose
string values get sanitized. Nothing about the behaviour changed.
Verified: run-ci.sh --rules PUBLIC-JARGON -> PASS. run-tests.sh -> 2884 passed.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01KKwgPbehDoAMdG3hPL79oi1 parent 65a1a1c commit e9600e9
1 file changed
Lines changed: 0 additions & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
232 | 232 | | |
233 | 233 | | |
234 | 234 | | |
235 | | - | |
236 | | - | |
237 | | - | |
238 | 235 | | |
239 | 236 | | |
240 | 237 | | |
| |||
0 commit comments