Commit 77da09b
* docs(metadata-protocol): add the #8957 fourth decline bullet to migrateStoredMetadata's JSDoc
`migrateStoredMetadata`'s "What it declines to touch, and says so" JSDoc
section listed three decline paths and never picked up the fourth one
#8957 (PR #9059, b740440) added: a row stored under a non-canonical
metadata type, reported `outcome: 'skipped'`. Mirrors the wording already
written at the `isNonCanonicalStoredType` call site's own inline comment.
Also adds one lead-in sentence naming the scope this JSDoc section
documents (the function's full internal surface, including the
no-reachable-automation-engine path no CLI caller can reach, since
`os migrate meta --stored` always supplies its own engine) — measured
true against this same JSDoc's own `canonicalizeFlow` parameter doc and
against cli.mdx. Does not add or remove any bullet to reconcile the
JSDoc's three (now four) items with cli.mdx's four items; that scope
split is a maintainer question, tracked on #9196.
Fixes #9196
* docs(metadata-protocol): narrow the scope lead-in sentence, per PM review
The lead-in sentence added in the previous commit said the section
documents the function's "full internal surface" -- overclaiming: the
JSDoc is also missing cli.mdx's flow-conflict-refused row, which IS
internal to the function (not CLI-caller-dependent), so "full" did not
hold. Narrowed the claim to what is actually demonstrated (the
flow-no-engine bullet specifically), and pointed the residual
scope-split question at the follow-up decision card (#9271) the PM
filed for it, rather than implying this sentence explains every gap
between the two lists.
Fixes #9196
---------
Co-authored-by: Claude <noreply@anthropic.com>
1 parent 5d4f3d5 commit 77da09b
1 file changed
Lines changed: 19 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
13090 | 13090 | | |
13091 | 13091 | | |
13092 | 13092 | | |
| 13093 | + | |
| 13094 | + | |
| 13095 | + | |
| 13096 | + | |
| 13097 | + | |
| 13098 | + | |
| 13099 | + | |
| 13100 | + | |
13093 | 13101 | | |
13094 | 13102 | | |
13095 | 13103 | | |
| |||
13120 | 13128 | | |
13121 | 13129 | | |
13122 | 13130 | | |
| 13131 | + | |
| 13132 | + | |
| 13133 | + | |
| 13134 | + | |
| 13135 | + | |
| 13136 | + | |
| 13137 | + | |
| 13138 | + | |
| 13139 | + | |
| 13140 | + | |
| 13141 | + | |
13123 | 13142 | | |
13124 | 13143 | | |
13125 | 13144 | | |
| |||
0 commit comments