feat: mark writable-only scans in the result footer - #5
Merged
Conversation
The two-line note above the table said the same thing every time and pushed the rows down with it. What the reader needs at that moment is short: the result set skipped read-only memory. It now rides in the footer, under the rows it qualifies — where the question "is this all of them?" is actually asked — as "20 rows in set — writable regions only (0.02 sec)". The scan, every refine and every later scan:results carry it, as before, and so does an empty set, where "nothing found" and "nothing found there" are different answers. Printer.table and Printer.footer take the marker, so any listing can carry a caveat about its rows without a paragraph above them.
Documentation build overview
4 files changed± quickstart.html± troubleshooting.html± guide/scanning.html± reference/commands.html |
The result footer changed shape, which anyone reading the table sees, so this is a minor rather than a patch. The quickstart's banner sample, the Sphinx fallback and the terminal capture carry the version literally, so all three move with it.
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
Replaces the two-line note that sat above every writable-only result set
with a short marker in the footer, under the rows it qualifies.
Before:
After:
The caveat is about the rows, so it belongs next to the rows — that is where
the eye already is when it asks whether the result set is everything.
Where it shows up
Unchanged in reach: the scan itself, every refine, and every later
scan:results, whether the restriction came from--writableor from thewritable_onlysetting. An empty result set keeps it too —Empty set — writable regions only— because "nothing found" and "nothingfound there" are different answers.
Implementation
Printer.tableandPrinter.footergained an optionalmarker, appended tothe count line before the timing. Any listing can now carry a caveat about its
rows without a paragraph above them; scanning is the only caller so far.
Also in this PR
help scan,help scanningand the docs showed a--writablescan without the marker, so they were updated.docs/guide/scanning.mdanddocs/troubleshooting.mddescribed the oldnote and now describe the footer.
was still on the 0.1.0 banner.
Version
Bumped to 0.2.0. The footer under every result table changed shape, which
is visible to anyone reading it, so this is a minor rather than a patch.
picklock/__init__.pyis the source hatch reads;docs/quickstart.md, theSphinx fallback in
docs/conf.pyand the terminal capture spell the versionout, so they move with it.
Checks
pytest: 927 passed, including the end-to-end scans against a real process.make lintandmake type-checkclean.not just that it appears.