Skip to content

[AIR] Fixed typos, grammar and a self-referencing link in the docs - #2172

Merged
Jolanrensen merged 2 commits into
masterfrom
air/typo-fixes-2026-10-20
Oct 20, 2026
Merged

Jolanrensen merged 2 commits into
masterfrom
air/typo-fixes-2026-10-20

Conversation

@jetbrains-air

@jetbrains-air jetbrains-air Bot commented Oct 20, 2026

Copy link
Copy Markdown
Contributor

Small, self-contained typo / grammar / misleading-documentation fixes found by scanning the repository. 25 fixes across 15 WriterSide topics; markdown prose only — no Kotlin, no public signatures (so no apiDump), and nothing inside a Korro <!---FUN--> block.

Self-referencing link

columnStatistics.md:5 — the page lists two kinds of column statistics, but the cumulative bullet linked back to columnStatistics.md, the page the reader is already on. cumulativeStatistics.md exists, is the page d.tree:184 publishes for exactly this content, and is what the summary bullet above it parallels. Retargeted.

Wrong word

File Was Now
group.md:5 Group columns into ColumnsGroups`` `ColumnGroups`
groupUngroupFlatten.md:5 removes all column groupings …, remaining only ValueColumns`` … leaving only ValueColumns``
median.md:22 the median is the low of the two middle values … the lower of the two …
explodeImplode.md:3 lists of values or DataFrame object in given columns … DataFrame objects …
operations.md:94 join two DataFrame object by an expression … objects …
readSqlFromCustomDatabase.md:504 does not always represent the actual values type … the actual value type
split.md:178 Equals to split { column }...`` Equivalent to …
staticInterpretation.md:77 they will be supported in the future release … in a future release

ColumnsGroups was the only occurrence in the repository; groupUngroupFlatten.md:3 already writes ColumnGroups. The explodeImplode.md and operations.md plurals were the odd ones out next to their own sibling bullets (implode on the next line, and join directly above joinWith), and multipleDataFrames.md:9 describes the same joinWith as joining two DataFrame objects.

Broken phrase

  • Data-Schemas-In-Kotlin-Notebook.md:138 — In order to enable support them in Kotlin, you should register them … had two competing constructions spliced together → In order to support them in Kotlin, ….
  • Data-Schemas-In-Kotlin-Notebook.md:104 — Despite dfhas additional columnweight, … used Despite with a finite clause → Even though dfhas an additional columnweight, ….
  • Data-Schemas-And-Extension-Properties-Troubleshooting.md:61 — since sometimes type can be inferred incorrect → since sometimes a type can be inferred incorrectly.

Misleading / inconsistent

  • xs.md:14 — it takes first ncolumns in dfs order … wherenis a number of givenkeyValues. Lowercase `dfs` reads as an abbreviation of *dataframes*, not of *depth-first search*, on a page whose whole subject is dataframes. `XsDocs` in `xs.kt:53` states the rule plainly — "the first `n` columns … a column group is not counted itself, but the columns inside it are" — so this is now `the first `n` columns in depth-first order … where `n` is the number of given `keyValues, matching the KDoc a user sees on hover.
  • implode.md:22 — Imploded ColumnGroupwill convert intoFrameColumn`` read as if the column group does the converting → will be converted into. The mirror sentence in `explode.md:27` already uses the passive.
  • rename.md:5 — Renames one or several columns without changing its location → their location, to agree with the plural subject.
  • readSqlFromCustomDatabase.md:109 — manage database connections and -tables: the suspended hyphen is a Dutch/German convention, not an English one (same class of fix as -types in [AIR] Fixed typos, grammar and a wrong Maven example link in docs and KDocs #2161) → connections and tables.
  • operations.md:123 — the unfold bullet was the one entry in a 60-item list joined by - instead of the — every sibling uses.
  • SetupKotlinNotebook.md:126 — [](Kotlin-DataFrame-Features-in-Kotlin-Notebook.md)that was missing the space after the link, so the resolved topic title ran into the next word.
  • readSqlFromCustomDatabase.md:347 — `getPreprocessedValueType() `to apply had the space inside the code span instead of after it, rendering the trailing space as code and gluing the backtick to to.

Grammar

  • operations.md:18,19 — Data transformation pipeline usually consists of … → A data transformation pipeline …; designed in functional style → in a functional style.
  • operations.md:36 — play with "people" dataset that is used in present guide → the "people" dataset that is used in this guide.
  • staticInterpretation.md:3,29,72 — three sentences opened on a bare noun phrase (Plugin evaluates …, Generated code itself is …, Compiler plugin aims to …) → The plugin evaluates …, The generated code itself is …, The compiler plugin aims to ….

Verification

  • Re-ran the duplicate-word, misspelling-dictionary and low-frequency/edit-distance scanners after the change: every fixed item is gone from the tree and no new one appeared. The first two now return nothing but false positives repo-wide (@param name name of … KDoc style, and one untill in the dead plugins/kotlin-dataframe legacy copy), so this round is prose-level rather than spelling-level.
  • columnStatistics.md's new target was checked on disk and in d.tree; every *.md link in all 15 touched files was resolved against topics/** — none missing.
  • Confirmed every edited line sits outside the <!---FUN--> / <!---END--> blocks the CI bot regenerates, by extracting the changed line numbers from the diff and intersecting them with each file's block ranges (0 hits). Seven of the files carry Korro blocks; the other eight have none.
  • Pre-existing trailing whitespace on three touched lines (group.md:5, readSqlFromCustomDatabase.md:347, Data-Schemas-And-Extension-Properties-Troubleshooting.md:61) was left intact, so markdown line breaks render unchanged — git diff --check flags exactly those three, and the removed and added sides both end in a space.
  • The diff touches no *.kt, *.kts or api/*.api file, so ktlint and binary-compatibility-validator have nothing to check here; generated-sources/ has no copy of docs/StardustDocs/topics, and the bot regenerates the Korro output in these topics itself.
  • Not run locally: Gradle cannot resolve its plugins in this sandbox (no network to the Gradle Plugin Portal — org.gradle.toolchains.foojay-resolver-convention:1.0.0 fails), so no Gradle task was executed. Nothing in this diff is compiled or sample-driven, so the structural checks above cover it.

Produced by Air Automations. Name: Bi-weekly Grammar Nazi / Run: https://air.jetbrains.cloud/org/05cf1a7f-6ab5-713b-abd3-29d0c8a05e2d/automations/a9009d9e-63e7-4730-801c-185f5785b6bd?run=d8700d5d-1882-4842-a986-8b213a6b5a0f

🤖 Generated with Claude Code

Air and others added 2 commits October 20, 2026 13:11
25 small prose fixes across 15 WriterSide topics: a `columnStatistics.md`
link that pointed at its own page instead of `cumulativeStatistics.md`,
the `ColumnsGroups` typo, several wrong words ("remaining only",
"the low of the two middle values", "the actual values type") and
broken phrases ("In order to enable support them", "Despite `df` has").

Markdown prose only — no Kotlin, no public signatures, and nothing
inside a Korro `<!---FUN-->` block.

Produced by Air Automations. Name: Bi-weekly Grammar Nazi / Run: https://air.jetbrains.cloud/org/05cf1a7f-6ab5-713b-abd3-29d0c8a05e2d/automations/a9009d9e-63e7-4730-801c-185f5785b6bd?run=d8700d5d-1882-4842-a986-8b213a6b5a0f

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@Jolanrensen
Jolanrensen merged commit 3c8c014 into master Oct 20, 2026
3 checks passed
@Jolanrensen
Jolanrensen deleted the air/typo-fixes-2026-10-20 branch October 20, 2026 14:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant