Commit 0c5108e
committed
docs(github): record why the strict guards stop at writes
The TSDoc stated the boundary and the harm on a write, but not why reads are
deliberately excluded. Without that, the asymmetry reads as an unfinished pass
and the next contributor "completes" it, breaking a paste flow that works today
for no safety gain.
Records both halves of the reasoning: the harm is asymmetric (a write mutates a
resource the caller never named, unrecoverably and invisibly, since every
traversal assertion still passes; a read returns data from the resource they
almost certainly meant), and the cost of refusing runs the other way (a padded
id on a read is overwhelmingly a stray newline in a paste). States the
principle underneath both guards: refuse where being wrong is unrecoverable,
tolerate where being wrong is merely unhelpful.
Comment-only; no behaviour change.1 parent d2c74d7 commit 0c5108e
1 file changed
Lines changed: 21 additions & 4 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
422 | 422 | | |
423 | 423 | | |
424 | 424 | | |
425 | | - | |
426 | | - | |
427 | | - | |
428 | | - | |
| 425 | + | |
| 426 | + | |
| 427 | + | |
| 428 | + | |
| 429 | + | |
| 430 | + | |
| 431 | + | |
| 432 | + | |
| 433 | + | |
| 434 | + | |
| 435 | + | |
| 436 | + | |
| 437 | + | |
| 438 | + | |
| 439 | + | |
| 440 | + | |
| 441 | + | |
| 442 | + | |
| 443 | + | |
| 444 | + | |
| 445 | + | |
429 | 446 | | |
430 | 447 | | |
431 | 448 | | |
| |||
0 commit comments