Fix some nits in the book docs to avoid codespell exceptions - #7242
Conversation
| computed first and then they are all written simultaneously. As a result, | ||
| a computed value cannot be referenced in another expression. If you need | ||
| to re-use a computed result, this can be done by chaining multiple `put` operators. | ||
| to reuse a computed result, this can be done by chaining multiple `put` operators. |
There was a problem hiding this comment.
While both "re-use" and "reuse" are considered acceptable spellings in general, a web search indicates that the former spelling is used ~10-15% of the time in typical writing, so codespell flags it it by default. We currently have 10 instances of "reuse" elsewhere in the repo and this was the only "re-use".
| { city: "Berkeley", state: "CA", population: 121643::uint32 }::=city_schema | ||
| { city: "Broad Cove", state: "ME", population: 806::uint32 }::=city_schema | ||
| { city: "Baton Rouge", state: "LA", population: 221599::uint32 }::=city_schema | ||
| { city: "Sioux Falls", state: "SD", population: 192517::uint32 }::=city_schema |
There was a problem hiding this comment.
Codespell happens to flag "rouge" as a likely misspelling of "rogue". While we don't currently use "rogue" anywhere in the repo, it may come up, so rather than add an exception that could cause us to miss a real typo down the road, since this read as an arbitrary trio of small/medium/large cities, I'm proposing using a different city that happens to match the default codespell dictionary. And since this example appears verbatim in a ztest, I changed it there to match.
philrz
changed the title
2 participants
I'm close to being able to turn on codespell for the book docs to help us catch typos and misspellings more quickly in the future. That means any words flagged by codespell that we want to leave as is would need to be added to an "exceptions" list. While we're free to do that, here I advocate fixing a couple nits in the current docs so we can avoid a couple of those exceptions.