Skip to content

Commit eb71f0d

Browse files
committed
Update CumSum documentation for clarity and consistency
Refine the CumSum API documentation by improving phrasing, fixing formatting issues, and ensuring consistency in references. This improves readability and better explains behavior, especially for nullable values and default parameters.
1 parent 6c1c027 commit eb71f0d

File tree

1 file changed

+20
-17
lines changed
  • core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api

1 file changed

+20
-17
lines changed

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

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -24,31 +24,34 @@ import kotlin.reflect.typeOf
2424
/**
2525
* ## The CumSum Operation
2626
*
27-
* Computes the cumulative sum of the values in the {@get DATA_TYPE}.
27+
* Computes the cumulative sums of the values in the each column from the {@get [CumSumDocs.DATA_TYPE]}
28+
* from the first row to the last row.
2829
*
2930
* __NOTE:__ If the column contains nullable values and `skipNA` is set to `true`,
30-
* skips null values when computing the cumulative sum.
31+
* null values are skipped when computing the cumulative sum.
3132
* Otherwise, any null value encountered will propagate null values in the output from that point onward.
3233
*
33-
* {@get [CUMSUM_PARAM] @param [columns]
34+
* {@get [CumSumDocs.CUMSUM_PARAM] @param [columns\]
3435
* The names of the columns to apply cumSum operation.}
3536
*
36-
* @param [skipNA] Whether to skip null values (default: `true`).
37+
* @param [skipNA\] Whether to skip null values (default: `true`).
3738
*
38-
* @return A new {@get DATA_TYPE} of the same type with the cumulative sum of the values.
39+
* @return A new {@get [CumSumDocs.DATA_TYPE]} of the same type with the cumulative sums.
3940
*
40-
* {@get [CUMSUM_PARAM] @see [Selecting Columns][SelectSelectingOptions].}
41+
* {@get [CumSumDocs.CUMSUM_PARAM] @see [Selecting Columns][SelectSelectingOptions].}
4142
* @see {@include [DocumentationUrls.CumSum]}
4243
*/
4344
@ExcludeFromSources
4445
@Suppress("ClassName")
4546
private interface CumSumDocs {
4647
interface CUMSUM_PARAM
48+
49+
interface DATA_TYPE
4750
}
4851

4952
/**
5053
* {@include [CumSumDocs]}
51-
* {@set DATA_TYPE [DataColumn]}.
54+
* {@set [CumSumDocs.DATA_TYPE] [DataColumn]}
5255
* {@set [CumSumDocs.CUMSUM_PARAM]}
5356
*/
5457
public fun <T : Number?> DataColumn<T>.cumSum(skipNA: Boolean = defaultCumSumSkipNA): DataColumn<T> =
@@ -114,7 +117,7 @@ private val supportedClasses = setOf(
114117

115118
/**
116119
* {@include [CumSumDocs]}
117-
* {@set DATA_TYPE [DataFrame]}.
120+
* {@set [CumSumDocs.DATA_TYPE] [DataFrame]}
118121
*/
119122
public fun <T, C> DataFrame<T>.cumSum(
120123
skipNA: Boolean = defaultCumSumSkipNA,
@@ -124,14 +127,14 @@ public fun <T, C> DataFrame<T>.cumSum(
124127

125128
/**
126129
* {@include [CumSumDocs]}
127-
* {@set DATA_TYPE [DataFrame]}.
130+
* {@set [CumSumDocs.DATA_TYPE] [DataFrame]}
128131
*/
129132
public fun <T> DataFrame<T>.cumSum(vararg columns: String, skipNA: Boolean = defaultCumSumSkipNA): DataFrame<T> =
130133
cumSum(skipNA) { columns.toColumnSet() }
131134

132135
/**
133136
* {@include [CumSumDocs]}
134-
* {@set DATA_TYPE [DataFrame]}.
137+
* {@set [CumSumDocs.DATA_TYPE] [DataFrame]}
135138
*/
136139
@AccessApiOverload
137140
public fun <T> DataFrame<T>.cumSum(
@@ -141,15 +144,15 @@ public fun <T> DataFrame<T>.cumSum(
141144

142145
/**
143146
* {@include [CumSumDocs]}
144-
* {@set DATA_TYPE [DataFrame]}.
147+
* {@set [CumSumDocs.DATA_TYPE] [DataFrame]}
145148
*/
146149
@AccessApiOverload
147150
public fun <T> DataFrame<T>.cumSum(vararg columns: KProperty<*>, skipNA: Boolean = defaultCumSumSkipNA): DataFrame<T> =
148151
cumSum(skipNA) { columns.toColumnSet() }
149152

150153
/**
151154
* {@include [CumSumDocs]}
152-
* {@set DATA_TYPE [DataFrame]}.
155+
* {@set [CumSumDocs.DATA_TYPE] [DataFrame]}
153156
* {@set [CumSumDocs.CUMSUM_PARAM]}
154157
*/
155158
public fun <T> DataFrame<T>.cumSum(skipNA: Boolean = defaultCumSumSkipNA): DataFrame<T> =
@@ -163,7 +166,7 @@ public fun <T> DataFrame<T>.cumSum(skipNA: Boolean = defaultCumSumSkipNA): DataF
163166

164167
/**
165168
* {@include [CumSumDocs]}
166-
* {@set DATA_TYPE [GroupBy]}.
169+
* {@set [CumSumDocs.DATA_TYPE] [GroupBy]}
167170
*/
168171
public fun <T, G, C> GroupBy<T, G>.cumSum(
169172
skipNA: Boolean = defaultCumSumSkipNA,
@@ -172,14 +175,14 @@ public fun <T, G, C> GroupBy<T, G>.cumSum(
172175

173176
/**
174177
* {@include [CumSumDocs]}
175-
* {@set DATA_TYPE [GroupBy]}.
178+
* {@set [CumSumDocs.DATA_TYPE] [GroupBy]}
176179
*/
177180
public fun <T, G> GroupBy<T, G>.cumSum(vararg columns: String, skipNA: Boolean = defaultCumSumSkipNA): GroupBy<T, G> =
178181
cumSum(skipNA) { columns.toColumnSet() }
179182

180183
/**
181184
* {@include [CumSumDocs]}
182-
* {@set DATA_TYPE [GroupBy]}.
185+
* {@set [CumSumDocs.DATA_TYPE] [GroupBy]}
183186
*/
184187
@AccessApiOverload
185188
public fun <T, G> GroupBy<T, G>.cumSum(
@@ -189,7 +192,7 @@ public fun <T, G> GroupBy<T, G>.cumSum(
189192

190193
/**
191194
* {@include [CumSumDocs]}
192-
* {@set DATA_TYPE [GroupBy]}.
195+
* {@set [CumSumDocs.DATA_TYPE] [GroupBy]}
193196
*/
194197
@AccessApiOverload
195198
public fun <T, G> GroupBy<T, G>.cumSum(
@@ -199,7 +202,7 @@ public fun <T, G> GroupBy<T, G>.cumSum(
199202

200203
/**
201204
* {@include [CumSumDocs]}
202-
* {@set DATA_TYPE [GroupBy]}.
205+
* {@set [CumSumDocs.DATA_TYPE] [GroupBy]}
203206
* {@set [CumSumDocs.CUMSUM_PARAM]}
204207
*/
205208
public fun <T, G> GroupBy<T, G>.cumSum(skipNA: Boolean = defaultCumSumSkipNA): GroupBy<T, G> =

0 commit comments

Comments
 (0)