Repository navigation
docs: the whole documentation checked against the code and written for a newcomer - #58
Merged
Merged
Conversation
…wcomer The guide had drifted from the code in a few dozen places, and its prose read as working notes. Each page now matches what the library does today, with its sample outputs taken from a fresh run, and says the essential first in whole sentences, without dashes, semicolons or internal references. Among the facts that changed, the writer stores a chunk of one value as a constant rather than a progression, and the demonstration file is 1 508 316 bytes in 54 segments. Groups come in no promised order without an OrderBy, KeyCountAsync counts the entries under the current key, and owned batches keep their selection. Lists of records, char, arrays and dictionaries all map, an untyped non-nullable column over a nullable one is refused, the file statistics carry no sum, and vxdump exits with 2 on an unknown option. The errors page gains the memory, torn-commit and integrity exceptions, and the observability page gains the event counters and the grouping statistics. Two sample labels follow the code. The key cursor prints the entries under a key, and the required-index sample says the path still holds the file written before it.
…e with the code The design documents used section numbers as cross-references and read as a journal. Every pointer is now a named link to its section, the numbered headings stay so that existing anchors still resolve, and the prose is whole sentences without dashes or semicolons. Among the facts that changed, a map has a factory and maps to a dictionary, lists of records are supported, a decimal bucket is not implemented, and the exception hierarchy has four kinds. A caller's bytes are copied once when they are not 64-byte aligned, the mapping cache works on Windows, top-level extensions are row-encoded by their storage while nested ones are refused, and the commit header inlines up to 192 KiB of a 256 KiB opening read. Repacking is not public, the per-encoding corpus is 61 files, and the writer also tries OnPair and, under the size-first profile, pco.
The same rewrite for the pages outside the guide: whole sentences, no dashes or semicolons, no internal references. The facts follow the repository: 876 corpus files and 2 571 779 rows, a forged legacy stats layout that closes the corpus's one coverage gap, row-encoding vectors produced by their own crate, 61 throughput files, a fourth test collection that runs alone, and no kernel benchmark class that does not exist.
Three XML summaries said something the code no longer does. A group by promised key order on a dictionary key, a hint named only progressions as written before it, and the fragment option pointed at an internal member. Three comments cited plans that are not in the repository, and the query scenarios carried step codes a reader cannot look up. They now say what they measure.
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.
Intent
Make the documentation something a newcomer can rely on and read with pleasure. An audit of every page against the code found a few dozen statements that had drifted (stale outputs, behaviours that changed, members that are internal), and the prose read as working notes: dashes, semicolons, section numbers as cross-references, internal step codes, and "few words. Then the sentence" openings.
The branch fixes the facts and rewrites the prose of the guide, the design documents, the READMEs and the contribution notes. Each page now says the essential first, in whole sentences, at an engineer's level.
What it brings
Among the corrections: a chunk of one value is written as a constant, groups come in no promised order without an
OrderBy,KeyCountAsynccounts the entries under the current key, owned batches keep their selection, lists of records and maps are supported, a decimal bucket is not implemented, the corpus is 876 files and the per-encoding corpus 61, and vxdump exits with 2 on an unknown option.Risks and tests
dotnet build Vorticity.slnx -c Releasepasses with no warning, so every<see cref>resolves.Left as it is, on purpose
caveatsandskippedentries of the corpus manifest still sayvortex-rowdoes not exist. They are written by conformance-gen and change with a corpus regeneration.Commits