Repository navigation
docs: add a runnable example to Screen::mask_matching - #551
Merged
Merged
Conversation
mask_rect, mask_matching and mask_cells explain why they mask the grid and not the text, but none had an example that compiles. Add a PTY-free doctest on mask_matching: parse a one-row screen, mask the clock with a visible fill, and assert both the text and that the size did not change. Signed-off-by: Cestercian <183791452+cestercian@users.noreply.github.com>
vyncint
approved these changes
Oct 2, 2026
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.
What & why
mask_matchingexplains why masking keeps the grid's width, but nothing compiles an example of it (the README one isrust,ignore). This adds a PTY-free doctest: parse a one-row screen with a clock, mask12:34:56with#, and assert both the masked text (Build ######## ok) and that the size did not change. Docs only, no signature changes.Closes #543
Checklist
cargo fmt --allandcargo clippy --workspace --all-targets --all-featuresare cleangit commit -s)CHANGELOG.mdupdated under[Unreleased](user-facing changes only): n/a, doc comment onlycargo insta review, not blind-accepted: n/acargo test --doc -p termlens mask_matchingandRUSTDOCFLAGS='-D warnings' cargo doc --no-depspass.