docs(readme): say what each compressed view still shows - #10
Merged
Merged
Conversation
The reduction table listed inputs and byte counts under a heading that read as the share kept when it was the share removed. Each row now says what the agent reads instead of the original: the failing test with its values, the one fatal line after a thousand retries, the receipt with its amount. The checker reads the label from the first cell and the figures from the last three, so the explanatory column can be reworded without touching 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
1 participant
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.
Summary
The README reduction table was hard to read: it listed inputs and byte counts under a Kept heading that actually meant the share removed, and never said what the agent gets to see. Each row now carries a column describing what survives in the view (the failing test with its expected and received values, the one fatal line after a thousand retries, the receipt with its exact amount, the table rows selected from a JSON array), and the columns are named Printed, Read and Removed. The intro explains that the difference is on disk and recoverable.
scripts/check_readme.pynow takes the label from the first cell and the figures from the last three, so the explanatory column can be reworded freely; it still fails the build if any figure drifts. Verified against the release binary: 9 rows match.