docs: lead with the action and split the test inventory - #9
Merged
Merged
Conversation
Purpose-first instructions forced readers to hold setup before reaching the operative clause, and the test inventory packed six independent claims into one sentence that no longer scans. Unknown-key wording also contradicted resolveOptions, which ignores unknown keys rather than defaulting them.
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.
Pre-release polish of the user-facing docs with no code or behavior changes. Nine sentences now lead with the operative clause instead of making the reader hold setup first, the test-file inventory becomes a scannable list with identical claims, and the unknown-key sentence now matches what resolveOptions actually does (unknown keys are ignored; only wrong-type values fall back). Worth a careful read of the configuration.md one-liner, since it corrects a factual claim rather than just reordering words.