docs: say which fields a box exposes, and narrow the colon rule - #48
Merged
Merged
Conversation
- annotate the box sample with the field it reads, and say the Val's own fields are gone from it - a member may not take the name of a field the Val holds, another trait's requirement included, reported at `implTrait` - move `A trait is a contract between Vals` above the defaults, where the brand is first at stake
- a noun phrase naming what came before stays, a full clause becomes two sentences, and a reason becomes `because` - the old rule kept a colon for any reason or detail, which covers most of them, and the docs run one mid-sentence colon per eight sentences
- 26 sites across the book, one per sentence pair - two become `because`, where the colon carried the reason - a noun phrase after the colon stays, such as the shape's field list
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.
What changed
Traits
p.idis a type error, becausedyndrops the concrete typethat Val requires included. That one is reported at
implTrait, not at the declarationA trait is a contract between Valsabove the defaults, where the brand is first at stakeThe colon rule
The old rule kept a colon wherever the second half gave a reason or a detail, which covers most of
them, and the book ran one mid-sentence colon per eight sentences. The rule now reads what follows
the colon: a noun phrase naming what came before stays, a full clause becomes two sentences, and a
reason becomes
because.becausethe shape: the fields every variant holds