Merge pull request #411 from Kotlin/na-and-nan-docs

NA and NaN docs

Author: Jolanrensen

core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/documentation/DocumentationUrls.kt

@@ -19,6 +19,16 @@ internal interface DocumentationUrls {
         interface RowConditions
     }
 
+    /** [See `NaN` and `NA` on the documentation website.](https://kotlin.github.io/dataframe/nanAndNa.html) */
+    interface NanAndNa {
+
+        /** [See `NaN` on the documentation website.](https://kotlin.github.io/dataframe/nanAndNa.html#nan) */
+        interface NaN
+
+        /** [See `NA` on the documentation website.](https://kotlin.github.io/dataframe/nanAndNa.html#na) */
+        interface NA
+    }
+
     /** [See `update` on the documentation website.](https://kotlin.github.io/dataframe/update.html) */
     interface Update
 

core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/documentation/NA.kt

@@ -13,6 +13,8 @@ import org.jetbrains.kotlinx.dataframe.api.fillNA
  * You can also use [fillNA][fillNA] to replace `NAs` in certain columns with a given value or expression
  * or [dropNA][dropNA] to drop rows with `NAs` in them.
  *
+ * For more information: [See `NA` on the documentation website.](https://kotlin.github.io/dataframe/nanAndNa.html#na)
+ *
  * @see NaN
  */
 internal interface NA

core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/documentation/NaN.kt

@@ -11,6 +11,8 @@ import org.jetbrains.kotlinx.dataframe.api.fillNaNs
  * You can also use [fillNaNs][fillNaNs] to replace `NaNs` in certain columns with a given value or expression
  * or [dropNaNs][dropNaNs] to drop rows with `NaNs` in them.
  *
+ * For more information: [See `NaN` on the documentation website.](https://kotlin.github.io/dataframe/nanAndNa.html#nan)
+ *
  * @see NA
  */
 internal interface NaN

core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/documentation/DocumentationUrls.kt

@@ -19,6 +19,16 @@ internal interface DocumentationUrls {
         interface RowConditions
     }
 
+    /** [{@include [Text]}{@arg [NameArg] `NaN` and `NA`}]({@include [Url]}/nanAndNa.html) */
+    interface NanAndNa {
+
+        /** [{@include [Text]}{@arg [NameArg] `NaN`}]({@include [Url]}/nanAndNa.html#nan) */
+        interface NaN
+
+        /** [{@include [Text]}{@arg [NameArg] `NA`}]({@include [Url]}/nanAndNa.html#na) */
+        interface NA
+    }
+
     /** [{@include [Text]}{@arg [NameArg] `update`}]({@include [Url]}/update.html) */
     interface Update
 

core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/documentation/NA.kt

@@ -13,6 +13,8 @@ import org.jetbrains.kotlinx.dataframe.api.fillNA
  * You can also use [fillNA][fillNA] to replace `NAs` in certain columns with a given value or expression
  * or [dropNA][dropNA] to drop rows with `NAs` in them.
  *
+ * For more information: {@include [DocumentationUrls.NanAndNa.NA]}
+ *
  * @see NaN
  */
 internal interface NA

core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/documentation/NaN.kt

@@ -11,6 +11,8 @@ import org.jetbrains.kotlinx.dataframe.api.fillNaNs
  * You can also use [fillNaNs][fillNaNs] to replace `NaNs` in certain columns with a given value or expression
  * or [dropNaNs][dropNaNs] to drop rows with `NaNs` in them.
  *
+ * For more information: {@include [DocumentationUrls.NanAndNa.NaN]}
+ *
  * @see NA
  */
 internal interface NaN

docs/StardustDocs/d.tree

@@ -35,6 +35,7 @@
         <toc-element topic="DataColumn.md"/>
         <toc-element topic="DataRow.md"/>
     </toc-element>
+    <toc-element topic="nanAndNa.md"/>
     <toc-element topic="operations.md"/>
     <toc-element toc-title="Operations">
         <toc-element topic="create.md">

docs/StardustDocs/topics/cumSum.md

@@ -11,7 +11,7 @@ cumSum(skipNA = true) [ { columns } ]
 Returns a [`DataFrame`](DataFrame.md) or [`DataColumn`](DataColumn.md) containing the cumulative sum.
 
 **Parameters:**
-* `skipNA` — when `true`, ignores `NA` (`null` or `NaN`) values. 
+* `skipNA` — when `true`, ignores [`NA` values](nanAndNa.md#na) (`null` or `NaN`). 
   When `false`, all values after first `NA` will be `NaN` (for `Double` and `Float` columns) or `null` (for integer columns).
 
 **Available for:**

docs/StardustDocs/topics/drop.md

@@ -55,7 +55,7 @@ df.dropNulls(whereAllNull = true) { city and weight } // remove rows with null v
 
 ## dropNaNs
 
-Remove rows with `Double.NaN` or `Float.NaN` values
+Remove rows with [`NaN` values](nanAndNa.md#nan) (`Double.NaN` or `Float.NaN`).
 
 <!---FUN dropNaNs-->
 
@@ -72,7 +72,7 @@ df.dropNaNs(whereAllNaN = true) { age and weight } // remove rows where both 'ag
 
 ## dropNA
 
-Remove rows with `null`, `Double.NaN` or `Float.NaN` values
+Remove rows with [`NA` values](nanAndNa.md#na) (`null`, `Double.NaN`, or `Float.NaN`).
 
 <!---FUN dropNA-->
 

docs/StardustDocs/topics/fill.md

@@ -21,7 +21,7 @@ df.update { colsOf<Int?>() }.where { it == null }.with { -1 }
 
 ## fillNaNs
 
-Replaces `Double.NaN` and `Float.NaN` values with given value or expression.
+Replaces [`NaN` values](nanAndNa.md#nan) (`Double.NaN` and `Float.NaN`) with given value or expression.
 
 <!---FUN fillNaNs-->
 
@@ -34,7 +34,7 @@ df.fillNaNs { colsOf<Double>() }.withZero()
 
 ## fillNA
 
-Replaces `null`, `Double.NaN` and `Float.NaN` values with given value or expression.
+Replaces [`NA` values](nanAndNa.md#na) (`null`, `Double.NaN`, and `Float.NaN`) with given value or expression.
 
 <!---FUN fillNA-->