Skip to content

Fix some nits in the book docs to avoid codespell exceptions #7242

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
philrz merged 1 commit into from
Aug 25, 2026
+4 −4
Merged

Fix some nits in the book docs to avoid codespell exceptions #7242

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion book/src/formats/sup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -419,7 +419,7 @@ A relational table might look like this:
```
{ 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

@philrz philrz Aug 25, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

```
The text here depicts three record values. It defines a type called `city_schema`
and the inferred type of the `city_schema` has the signature:
Expand Down
2 changes: 1 addition & 1 deletion book/src/super-sql/operators/put.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ while modified fields are mutated in place.
If multiple fields are written in a single `put`, all the new field values are
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.

@philrz philrz Aug 25, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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".


The `put` keyword is optional since it can be used as a [shortcut](intro.md#shortcuts).
When used as a shortcut, the `<field>:=` portion of `<assignment>` is not optional.
Expand Down
4 changes: 2 additions & 2 deletions sup/ztests/outer-schema.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ inputs:
type city_schema={city:string,state:string,population:int64}
{city:"Berkeley",state:"CA",population:121643}::city_schema
{city:"Broad Cove",state:"ME",population:806}::city_schema
{city:"Baton Rouge",state:"LA",population:221599}::city_schema
{city:"Sioux Falls",state:"SD",population:192517}::city_schema

outputs:
- name: stdout
data: |
type city_schema={city:string,state:string,population:int64}
{city:"Berkeley",state:"CA",population:121643}::city_schema
{city:"Broad Cove",state:"ME",population:806}::city_schema
{city:"Baton Rouge",state:"LA",population:221599}::city_schema
{city:"Sioux Falls",state:"SD",population:192517}::city_schema
Loading