Merge pull request #2184 from Kotlin/air/typo-fixes-2026-10-23

[AIR] Fixed typos, grammar and four copy-pasted grammar KDoc links

Author: Jolanrensen

KDOC_GUIDELINES.md

@@ -198,7 +198,7 @@ In the future, we want to have nice topic names with backticks
 
 All KDoc-helpers must be `internal` or `private`!
 
-Some of KDoc-helpers can be used both as -snippets and -topics.
+Some KDoc-helpers can be used both as snippets and as topics.
 
 ### Common KDoc-helpers
 
@@ -330,13 +330,13 @@ and it should be continued with other methods. Also add a note about the [operat
 For example (from the `insert` KDoc):
 
 ```
- * This function does not immediately insert the new column but instead specify a column to insert and
+ * This function does not immediately insert the new column but instead specifies a column to insert and
  * returns an [InsertClause],
  * which serves as an intermediate step.
  * The [InsertClause] object provides methods to insert a new column using:
  * - [under][InsertClause.under] - inserts a new column under the specified column group.
  * - [after][InsertClause.after] - inserts a new column after the specified column.
- * - [at][InsertClause.at]- inserts a new column at the specified position.
+ * - [at][InsertClause.at] - inserts a new column at the specified position.
  *
  * Each method returns a new [DataFrame] with the inserted column.
  * 

core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/all.kt

@@ -132,7 +132,7 @@ public interface AllColumnsSelectionDsl<out _UNUSED> {
         /** [**`Before`**][ColumnsSelectionDsl.allColsBefore] */
         public typealias Before = Nothing
 
-        /** [**`After`**][ColumnsSelectionDsl.allAfter] */
+        /** [**`After`**][ColumnsSelectionDsl.allColsAfter] */
         public typealias After = Nothing
 
         /** [**`From`**][ColumnsSelectionDsl.allColsFrom] */

core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/colsOfKind.kt

@@ -58,13 +58,13 @@ public interface ColsOfKindColumnsSelectionDsl {
      */
     public interface Grammar {
 
-        /** [**`colsOfKind`**][ColumnsSelectionDsl.colGroups] */
+        /** [**`colsOfKind`**][ColumnsSelectionDsl.colsOfKind] */
         public typealias PlainDslName = Nothing
 
-        /** __`.`__[**`colsOfKind`**][ColumnsSelectionDsl.colGroups] */
+        /** __`.`__[**`colsOfKind`**][ColumnsSelectionDsl.colsOfKind] */
         public typealias ColumnSetName = Nothing
 
-        /** __`.`__[**`colsOfKind`**][ColumnsSelectionDsl.colGroups] */
+        /** __`.`__[**`colsOfKind`**][ColumnsSelectionDsl.colsOfKind] */
         public typealias ColumnGroupName = Nothing
     }
 

core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/frameCols.kt

@@ -56,13 +56,13 @@ public interface FrameColsColumnsSelectionDsl {
      */
     public interface Grammar {
 
-        /** [**`frameCols`**][ColumnsSelectionDsl.colGroups] */
+        /** [**`frameCols`**][ColumnsSelectionDsl.frameCols] */
         public typealias PlainDslName = Nothing
 
-        /** __`.`__[**`frameCols`**][ColumnsSelectionDsl.colGroups] */
+        /** __`.`__[**`frameCols`**][ColumnsSelectionDsl.frameCols] */
         public typealias ColumnSetName = Nothing
 
-        /** __`.`__[**`frameCols`**][ColumnsSelectionDsl.colGroups] */
+        /** __`.`__[**`frameCols`**][ColumnsSelectionDsl.frameCols] */
         public typealias ColumnGroupName = Nothing
     }
 

core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/gather.kt

@@ -76,7 +76,7 @@ internal interface GatherDocs {
      * `\[ `__`.`__[**`cast`**][Gather.cast]**`<T>() `**`]`
      *
      * {@include [Indent]}
-     * `\[ `__`.`__[**`notNull`**][Gather.cast]**`() `**`]`
+     * `\[ `__`.`__[**`notNull`**][Gather.notNull]**`() `**`]`
      *
      * {@include [Indent]}
      * `\[ `__`.`__[**`where`**][Gather.where]**`  {  `**`filter: `[`RowValueFilter`][RowValueFilter]**` } `**`]`
@@ -251,8 +251,8 @@ public fun <T, C, K, R> Gather<T, C?, K, R>.notNull(): Gather<T, C, K, R> = wher
  * ```kotlin
  * // Gather `resultA` and `resultB` columns into a single "value" column,
  * // with the "series" column containing a key.
- * // Assuming `resultA` contains `Double` values and `
- * // resultB` contains `List<Double>` values,
+ * // Assuming `resultA` contains `Double` values
+ * // and `resultB` contains `List<Double>` values,
  * // `explodeLists` will apply only to values from `resultB`,
  * // resulting in all gathered values being of type `Double`.
  * df.gather { resultA and resultB }

core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/insert.kt

@@ -34,13 +34,13 @@ import kotlin.reflect.KProperty
 // region insert
 
 /**
- * This function does not immediately insert the new column but instead specify a column to insert and
+ * This function does not immediately insert the new column but instead specifies a column to insert and
  * returns an [InsertClause],
  * which serves as an intermediate step.
  * The [InsertClause] object provides methods to insert a new column using:
  * - [under][InsertClause.under] - inserts a new column under the specified column group.
  * - [after][InsertClause.after] - inserts a new column after the specified column.
- * - [at][InsertClause.at]- inserts a new column at the specified position.
+ * - [at][InsertClause.at] - inserts a new column at the specified position.
  *
  * Each method returns a new [DataFrame] with the inserted column.
  *
@@ -167,14 +167,14 @@ public inline fun <T, reified R> DataFrame<T>.insert(
  * An intermediate class used in the [insert] operation.
  *
  * This class itself does not perform any insertions — it is a transitional step
- * before specifying how to insert the selected columns.
+ * before specifying where to insert the new column.
  * It must be followed by one of the inserting methods
  * to produce a new [DataFrame] with an inserted column.
  *
  * Use the following methods to perform the insertion:
  * - [under][InsertClause.under] - inserts a new column under the specified column group.
  * - [after][InsertClause.after] - inserts a new column after the specified column.
- * - [at][InsertClause.at]- inserts a new column at the specified position.
+ * - [at][InsertClause.at] - inserts a new column at the specified position.
  *
  * See [Grammar][InsertDocs.Grammar] for more details.
  */

core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/typeConversions.kt

@@ -283,26 +283,29 @@ public enum class Infer {
  */
 public enum class NullabilityOptions {
     /**
-     * Use only actual data, set [DataColumn.hasNulls] to true if and only if there are null values in the column.
-     * On empty dataset use False.
+     * Use only actual data, set [DataColumn.hasNulls] to `true` if and only if there are null values in the column.
+     * On an empty dataset, use `false`.
      */
     Infer,
 
     /**
-     * Set [DataColumn.hasNulls] to expected value. Throw exception if column should be not nullable but there are null values.
+     * Set [DataColumn.hasNulls] to the expected value.
+     * Throws an exception if the column should be not nullable but there are null values.
      */
     Checking,
 
     /**
-     * Set [DataColumn.hasNulls] to expected value by default. Change False to True if column should be not nullable but there are null values.
+     * Set [DataColumn.hasNulls] to the expected value by default.
+     * Change `false` to `true` if the column should be not nullable but there are null values.
      */
     Widening,
 }
 
 public class NullabilityException : Exception()
 
 /**
- * @return if column should be marked nullable for current [NullabilityOptions] value with actual [data] and [expectedNulls] per some schema/signature.
+ * @return whether the column should be marked nullable for the current [NullabilityOptions] value
+ * with actual [data] and [expectedNulls] per some schema/signature.
  * @throws [NullabilityException] for [NullabilityOptions.Checking] if [expectedNulls] is false and [data] contains nulls.
  */
 public fun NullabilityOptions.applyNullability(data: List<Any?>, expectedNulls: Boolean): Boolean {

dataframe-geo/src/main/kotlin/org/jetbrains/kotlinx/dataframe/geo/geocode/Geocoder.kt

@@ -23,7 +23,7 @@ import org.locationtech.jts.geom.GeometryFactory
 import org.locationtech.jts.io.geojson.GeoJsonReader
 
 /**
- * Experimental geo coding utility.
+ * Experimental geocoding utility.
  */
 @Experimental
 public object Geocoder {

dataframe-geo/src/main/kotlin/org/jetbrains/kotlinx/dataframe/geo/io/read.kt

@@ -22,7 +22,7 @@ import java.net.URL
  *
  * Each row in the resulting [GeoDataFrame] corresponds to a single
  * [`Feature`](https://datatracker.ietf.org/doc/html/rfc7946#section-3.2)
- * from the input file :
+ * from the input file:
  * * `"geometry"` value is stored in the `geometry` column.
  * * `"properties"` are flattened into individual columns using their keys as column names.
  * * `"crs"` is read as `null` if not specified (interpreted as WGS 84 by default).
@@ -31,7 +31,7 @@ import java.net.URL
  * > Nested properties are not supported and parsed as [`LinkedHashMap<*, *>`][java.util.LinkedHashMap].
  * > According to the specification, the CRS in GeoJSON should be
  * > [WGS 84](https://datatracker.ietf.org/doc/html/rfc7946#section-4);
- * > deprecated "crs" field is used for now;
+ * > the deprecated "crs" field is used for now;
  * > if it is not present, it is read as `null`.
  */
 @ExcludeFromSources

dataframe-geo/src/main/kotlin/org/jetbrains/kotlinx/dataframe/geo/io/write.kt

@@ -30,7 +30,7 @@ import kotlin.io.path.outputStream
  *
  * > According to the specification, the CRS in GeoJSON should be
  * > [WGS 84](https://datatracker.ietf.org/doc/html/rfc7946#section-4);
- * > deprecated "crs" field [is written for now](https://github.com/Kotlin/dataframe/issues/1187);
+ * > the deprecated "crs" field [is written for now](https://github.com/Kotlin/dataframe/issues/1187).
  */
 @ExcludeFromSources
 internal typealias WriteGeoJsonSnippet = Nothing