docs: correct the crate count in the tour and README - #7
Open
mparrett wants to merge 1 commit into
Open
Conversation
The tour disagreed with itself: the meta strip said 7 workspace crates, the §2 prose said six. Cargo.toml lists ten — the persistence split (fmpl-persistence, fmpl-types, fmpl-workspace-tests) landed after both numbers were written. The README's crate table was missing the same three. Descriptions are taken verbatim from each crate's own `description` field rather than invented here. Deliberately not touched: the ignored-test ledger further down the tour (74, ~50/~9/~5). Those numbers need a suite run to state honestly, and docs/known-gaps.md currently disagrees with them — see the PR body. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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.
Two small factual fixes to pages that are live right now. Independent of the routing question in #4 — these are wrong wherever the pages end up living.
Crate count
The tour disagrees with itself:
Cargo.tomllists ten. Both numbers predate the persistence split, which addedfmpl-persistence,fmpl-types, andfmpl-workspace-tests.The README's crate table was missing those same three. I took each description verbatim from the crate's own
descriptionfield rather than writing my own.What I did not touch, and why
The ignored-test ledger further down the tour reads 74 with buckets ~50 / ~9 / ~5. I started to correct that too and stopped, because I can't state better numbers honestly:
docs/known-gaps.mdsays "roughly 75 tests are#[ignore]d", with buckets of ~50 (pattern matching), 2 (optimizer), and 3 (web storylet)#[ignore]attributes plus 4 rustdoc```ignorefencesSo the tour and the gap ledger disagree with each other, and neither quite matches a naive count. Getting this right means running the suite and deciding whether rustdoc fences belong in the total — your call on both, since
specs/gaps.mdis now ground truth for this and you'd know the intended bucket definitions.Happy to do that as a follow-up if you tell me how you want the total defined. Or ignore it; nothing depends on it but the page.