Four passages stop describing themselves and describe their subject - #349
Merged
Merged
Conversation
`NOTICE.md` said that its provenance section exists because recording
provenance is worth doing on its own terms. `docs/MASTERPLAN.md` section 11
opened by saying what the section states. Both are the document talking about
itself, and a reader who wants the provenance or the dossier has to step over a
sentence about the document first.
The two `docs/BENCHMARK-METHODOLOGY.md` bullets carried a dash pair doing the
work of a subordinate clause, in a place where the sentence is a
security-posture claim about a decompression bomb. That is the passage where
the punctuation should be doing the least work.
No claim moves. The degradation factor stays 2.2-2.3x, the mutual exclusivity
of the throughput worst case and a bomb stays, the GDeflate provenance stays,
and section 11 still takes no design decision.
The 21 en dashes in this tree are number ranges and are deliberately untouched:
`git grep -oP '\x{2013}' -- '*.md' | wc -l` returns 21 before and after.
Closes #348
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
Four passages in three documents described themselves rather than their
subject.
NOTICE.mdsaid its provenance section exists because recordingprovenance is worth doing on its own terms;
docs/MASTERPLAN.mdsection 11opened by saying what the section states; and two bullets in
docs/BENCHMARK-METHODOLOGY.mdused a dash pair where a subordinate clausebelongs, in the sentences that carry the security-posture claim about a
decompression bomb.
No claim moves. The degradation factor stays 2.2-2.3x, the mutual exclusivity
of the throughput worst case and a bomb stays, the GDeflate provenance stays,
and section 11 still takes no design decision.
Closes #348
Type of change
Engineering checklist
Not applicable. No decode path, no device code, no API surface and no build
input is touched; the diff is three Markdown files.
being ticked. This change reaches no kernel, no format parsing, no C-ABI
boundary, no build tooling and no workflow, which is the set that
requires one.
GPU sanitizer gate
Performance checklist
Not applicable: nothing on the hot path is touched, and
docs/BENCHMARKS.mdis not among the changed files.
Quality checklist
keep every number.
in as a conformance test.
Verification
The build and test boxes are NOT ticked and the reason is stated rather than
implied: no C++ toolchain run was made for this change, because the diff
reaches no source, no header, no CMake input and no test. CI is the authority
here and its
buildandformatcontexts are what the ruleset requires.cmake --build build- not run, see above.ctest --test-dir build- not run, see above.commit:
Notes
The 21 en dashes in this tree are number ranges and are deliberately left
alone. Before and after the change:
The
docs/BENCHMARK-METHODOLOGY.mdbullet list keeps two of its bold openers,on the "No size amplification" and "The GPU advantage holds" items. Only the
first bullet lost its bold label, because that bullet's label ran into a dash
and then into the sentence, which is the construction the issue names. Making
the whole list consistent one way or the other is a larger judgement about that
document's voice and is not taken here.
There is no second reader on this change. The reasoning above and the commands
it quotes stand in place of one.
Correction, after the merge, to the number in the Notes above
The Notes section quoted
and that command does not return 21. It returns 24, at the base commit and at
the merge commit alike:
21 is the number of LINES carrying an en dash, which is what a per-file count
returns and what #348 counted:
2 plus 11 plus 8 is 21. So the figure was right about the tree and wrong about
the command that was pasted beside it, which is the pairing a reader checks.
The claim it supports is unchanged and is now measured with the command that
produces it: the en-dash count does not move across this change, 24 before and
24 after. #348's body carries the same wrong pairing and this is the correction
for both.