Correct the count of operations gRPC cannot serve, and the punctuation around them - #70
Merged
Merged
Conversation
Twenty-two em dashes across the README, STABILITY.md, the migration guide, CONTRIBUTING.md and the 2.0.0 changelog section, replaced with whatever the sentence actually wanted: a colon before a list, a full stop between two independent clauses, commas around a real aside. Several of them were standing in for two different marks in the same sentence, which is where the habit stops being shorthand and starts costing the reader. The one that stays is the status blockquote, whose shape STANDARD.md prescribes and the audit script checks. Mechanical boldface goes with it. STABILITY.md had nine paragraphs opening with a bolded sentence acting as a heading, and when every paragraph carries an emphasised line none of them is emphasised. Nineteen down to nine; what remains marks MAJOR, MINOR and PATCH, where the bold separates a defined term from its definition. Changelog sections older than 2.0.0 keep their punctuation. Their text generated the GitHub Release bodies at the time, and editing them now would leave the two disagreeing about a release nobody can cut again.
Fourteen, not eleven. The number came from the KDoc on GrpcQdrantTransport,
where it was written from memory and never checked against the class, and
from there it reached the README, STABILITY.md, the migration guide and the
changelog.
Two mistakes made it wrong. The enumeration said "the five shard-scope
snapshot operations" and there are six, since recoverShardSnapshot was
missing from the list. And downloadStorageSnapshot was left out entirely.
Counting the call sites settles it:
grep -o 'restOnly("[a-zA-Z]*")' GrpcQdrantTransport.kt | sort -u | wc -l
14
The enumeration is now written the way the code groups them, so the next
person can count the same fourteen without reconstructing the list: the two
issues calls together, the snapshot and storage-snapshot transfers together,
and the six shard-scope operations as a group.
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.
Two passes over the prose. No behaviour change, one KDoc touched.
The count was wrong
GrpcQdrantTransport's KDoc said eleven operations have no gRPC equivalent. There are fourteen. Thenumber was written from memory and never checked, and from that KDoc it reached the README,
STABILITY.md, the migration guide and the changelog.Two things made it wrong. The enumeration said "the five shard-scope snapshot operations" and there are
six, because
recoverShardSnapshotwas missing. AnddownloadStorageSnapshotwas left out of the listaltogether.
The enumeration now follows how the code groups them, so the next reader can arrive at fourteen without
reconstructing the list: the two issues calls, the snapshot and storage-snapshot transfers, and the six
shard-scope operations.
Punctuation and emphasis
Twenty-two em dashes across the same files, several of them standing in for two different marks inside
one sentence. Each is replaced by what the sentence wanted: a colon where a list follows, a full stop
between two independent clauses, commas around a genuine aside.
README.mdSTABILITY.mddocs/migrating-from-qdrant-client.mdCONTRIBUTING.mdCHANGELOG.md,[2.0.0]onlyThe one left in the README is the status blockquote, whose shape
STANDARD.mdprescribes andaudit-library.shgreps for.STABILITY.mdhad nine paragraphs opening with a bolded sentence doing the work of a heading. Whenevery paragraph carries an emphasised line, none of them is emphasised. What survives marks
MAJOR,MINORandPATCH, where the bold separates a defined term from its definition.Changelog sections before
2.0.0are left alone: their text generated the GitHub Release bodies at thetime, and rewriting them would leave the two disagreeing about a release nobody can cut again.
./gradlew buildgreen, audit At standard. Thev2.0.0Release body needs regenerating from thecorrected changelog after merge.