docs(book): the crate graph is derived instead of remembered - #864
Merged
Conversation
The page claimed the layers move 'whether or not anyone updates this page' and then documented eight layers over 18 crates, against nine over 20. kooch_pack was absent entirely, kooch_input and kooch_camera were two and three layers low, and kooch_render was listed in two tables at once. crate_layers.py reads the layering out of cargo metadata and --check compares it against the table, so the next edge somebody adds either updates the page or fails a command.
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.
The page said the layer of a crate is "derived from
cargo metadata, not assigned by hand" and that it moves "whether or not anyone updates this page". Both sentences were true of the method and false of the page.What the workspace actually says: 20 crates in 9 layers. The page said 18 in 8.
kooch_packkooch_coredepends on it — the asset server opens.kpackkooch_inputkooch_coreonlykooch_camerakooch_gravity— a rig asks which way up is, because on a planet up is not+Ykooch_renderkooch_editor_coreAnd the fix is not a better table.
.github/scripts/crate_layers.pyderives the layering fromcargo metadata;--checkcompares it against the table in the page and exits 1 on drift. So the next edge somebody adds either updates this page or fails a command.It is deliberately shallow — it compares crate names per layer and says nothing about the prose. A layer that moves is a fact; whether the paragraph explaining it still reads true is a judgement, and a script claiming to check that would be lying.
Fourth page of the pass over the book.