Repository navigation
docs: a review pass, fifteen claims the code contradicts - #562
Merged
Merged
Conversation
Each was checked against the code or by running it before it changed;
one more item is a style tidy, marked as such.
README:
- `Screen::parse` reads the snapshot format, not an insta `.snap`: it
rejects the `---` header on line 1. The body below it parses, and the
`termlens` command reads a whole `.snap` because it strips the header.
- The skill has five recipes, not four.
SKILL.md:
- §7's mask row said `mask_matching` "spans a wrap the way `find_all`
does". A value split by a soft wrap is two rows and stays unmasked
(measured: 10 columns, `SECRET-VALUE-42`); a needle with `\n` is what
spans rows. Rule 12 already says so for `contains`.
- Rule 10 said `format!("{:?}")` is the same as `Display`. It wraps the
text in `Screen(…)`, which `Screen::parse`, `diff` and `render` refuse.
- §6 said every error's `Display` ends with the screen. Only the wait
errors (timeout, EOF, emulator) and a failed write carry one.
SECURITY.md: "bot-authored commits are rejected by CI" is true except for
Dependabot, which CONTRIBUTING's AI tooling policy exempts from the
identity rule only; the provenance line now says so.
DESIGN.md:
- The writer queue is unbounded (`mpsc::channel`), capped on reply bytes;
one paragraph said bounded, the next unbounded.
- The user-facing Windows list is in docs/LIMITATIONS.md, not the README.
- `CSI 18 t` is answered, and `14 t`/`16 t` once a cell size is declared,
so "the non-pixel `CSI t` reports" were never all unanswered; the same
correction in LIMITATIONS.md names `11 t` and `19 t` instead.
- The compatibility corpus starts at 0.10.1, not "each published release".
emit's steps: an argument beginning with `--` must be a step, so `emit
--foo` exits 2 rather than printing `--foo`; TEXT and `--text` say so.
Rustdoc:
- `Unsupported`'s summary was `Clipboard`'s first sentence, so docs.rs
described the type as clipboard data; the sentence is back on
`Clipboard`, which had no summary.
- `assert_screen_snapshot!` repeated the Display-versus-Debug reason that
#559 corrected in the skill.
- `wait_frame` pointed at a README Windows note that is not in the README.
- `Screen`'s Debug impl said "exactly like Display"; it adds `Screen(…)`.
- Style, not a contradiction: `mask_matching` carried the crate's only
`# Examples` heading; the rest of the crate's doctests have none.
Found by a documentation sweep; the same sweep found the relative
`current_dir` bug and the inspect help errors fixed in #561.
Signed-off-by: Vyncint Ng <115854244+vyncint@users.noreply.github.com>
vyncint
force-pushed
the
docs/review-0.11.5
branch
from
October 7, 2026 00:03
c046ea0 to
0b794e0
Compare
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Each was checked against the code or by running it before it changed;
one more item is a style tidy, marked as such.
README:
Screen::parsereads the snapshot format, not an insta.snap: itrejects the
---header on line 1. The body below it parses, and thetermlenscommand reads a whole.snapbecause it strips the header.SKILL.md:
mask_matching"spans a wrap the wayfind_alldoes". A value split by a soft wrap is two rows and stays unmasked
(measured: 10 columns,
SECRET-VALUE-42); a needle with\nis whatspans rows. Rule 12 already says so for
contains.format!("{:?}")is the same asDisplay. It wraps thetext in
Screen(…), whichScreen::parse,diffandrenderrefuse.Displayends with the screen. Only the waiterrors (timeout, EOF, emulator) and a failed write carry one.
SECURITY.md: "bot-authored commits are rejected by CI" is true except for
Dependabot, which CONTRIBUTING's AI tooling policy exempts from the
identity rule only; the provenance line now says so.
DESIGN.md:
mpsc::channel), capped on reply bytes;one paragraph said bounded, the next unbounded.
CSI 18 tis answered, and14 t/16 tonce a cell size is declared,so "the non-pixel
CSI treports" were never all unanswered; the samecorrection in LIMITATIONS.md names
11 tand19 tinstead.emit's steps: an argument beginning with
--must be a step, soemit --fooexits 2 rather than printing--foo; TEXT and--textsay so.Rustdoc:
Unsupported's summary wasClipboard's first sentence, so docs.rsdescribed the type as clipboard data; the sentence is back on
Clipboard, which had no summary.assert_screen_snapshot!repeated the Display-versus-Debug reason thatdocs(skill): rule 9 gives the true reason, and §6 reads the Debug form too #559 corrected in the skill.
wait_framepointed at a README Windows note that is not in the README.Screen's Debug impl said "exactly like Display"; it addsScreen(…).mask_matchingcarried the crate's only# Examplesheading; the rest of the crate's doctests have none.Found by a documentation sweep; the same sweep found the relative
current_dirbug and the inspect help errors fixed in #561.