Describe storage internals in our own terms - #54
Merged
Conversation
Comment-only pass across the crate. Descriptions now stand on their own rather
than attributing a design to, or naming symbols from, another codebase.
No behaviour change. Deliberately untouched:
* serde alias attributes -- on-disk backward compatibility; removing one stops
existing data from being read;
* configuration identifiers and environment variable names -- renaming those
is a breaking change for deployments, not a documentation fix;
* ordinary English uses of the word reference (dangling reference, live index
references).
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
bjmeetsfo
force-pushed
the
oss/comment-hygiene
branch
from
August 19, 2026 03:14
a839f7b to
054a9ff
Compare
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
3 participants
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.
Comment-only pass across the crate. Descriptions of the storage internals now
stand on their own rather than being framed as comparisons.
No behaviour change: comment text only, no code, identifiers or string literals.
Deliberately untouched:
aliasattributes — on-disk backward compatibility; removing onestops existing data from being read.
is a breaking change for deployments, not a documentation fix.
reference (
dangling reference,live index references).