Skip to content

Commit b2a1f5c

Browse files
authored
small manual fixes for std kdocs
1 parent f3e69dd commit b2a1f5c

1 file changed

Lines changed: 10 additions & 5 deletions

File tree

  • core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api

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

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ import kotlin.reflect.typeOf
6060
*
6161
* ### Delta Degrees of Freedom (ddof)
6262
*
63-
* All `std` operations take a [`ddof`][DdofParam] ("Delta Degrees of Freedom") argument.
63+
* All `std` operations take a [`ddof`][Ddof] ("Delta Degrees of Freedom") argument.
6464
* The divisor used in the calculation is `N - ddof`, where `N` is the number of values.
6565
* The default is `1`, meaning DataFrame applies
6666
* [Bessel's correction](https://en.wikipedia.org/wiki/Bessel%27s_correction) and computes the
@@ -580,14 +580,19 @@ internal interface StdDocs : CommonStatisticsDocs {
580580
typealias ExpressionResultColumnNameParam = Nothing
581581

582582
/**
583-
* @comment The shared `ddof` parameter documentation. KDoc-snippet.
584-
*
585-
* @param [ddof\] "Delta Degrees of Freedom". The divisor used in the calculation is `N - ddof`,
583+
* "Delta Degrees of Freedom". The divisor used in the calculation is `N - ddof`,
586584
* where `N` is the number of values. The default is `1`, which applies
587585
* [Bessel's correction](https://en.wikipedia.org/wiki/Bessel%27s_correction) and computes the
588586
* unbiased sample standard deviation (as in R). Use `0` for the population standard deviation
589587
* (as in Numpy).
590588
*/
589+
typealias Ddof = Nothing
590+
591+
/**
592+
* @comment The shared `ddof` parameter documentation. KDoc-snippet.
593+
*
594+
* @param [ddof\] {@include [Ddof]}
595+
*/
591596
@ExcludeFromSources
592597
typealias DdofParam = Nothing
593598
}
@@ -662,7 +667,7 @@ public inline fun <T, reified R : Number?> DataColumn<T>.stdOf(
662667
* are taken into account; all other columns of the row are ignored.
663668
* @include [StdDocs.ColumnGroupsIgnoredSnippet]
664669
*
665-
* Since the values of different columns are combined together, the result is the standard deviation
670+
* Since the values of different columns are combined, the result is the standard deviation
666671
* of all those values converted to their common type.
667672
*
668673
* @include [StdDocs.SupportedTypesSnippet]

0 commit comments

Comments
 (0)