Skip to content

Commit 7a682aa

Browse files
params readability
1 parent 4acb2ba commit 7a682aa

File tree

1 file changed

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

1 file changed

+9
-9
lines changed

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ private interface SetInsertOperationArg
104104
* df.insert(count).after { url }
105105
* ```
106106
*
107-
* @param column A single [DataColumn] to insert into the [DataFrame].
107+
* @param [column] A single [DataColumn] to insert into the [DataFrame].
108108
* @return An [InsertClause] for specifying the placement of the new column.
109109
*/
110110
public fun <T, C> DataFrame<T>.insert(column: DataColumn<C>): InsertClause<T> = InsertClause(this, column)
@@ -132,9 +132,9 @@ public fun <T, C> DataFrame<T>.insert(column: DataColumn<C>): InsertClause<T> =
132132
* }.under("math")
133133
* ```
134134
*
135-
* @param name The name of the new column to be created and inserted.
136-
* @param infer Controls how values are inferred when building the new column. Defaults to [Infer.Nulls].
137-
* @param expression An [AddExpression] that computes the value for each row of the new column.
135+
* @param [name] The name of the new column to be created and inserted.
136+
* @param [infer] Controls how values are inferred when building the new column. Defaults to [Infer.Nulls].
137+
* @param [expression] An [AddExpression] that computes the value for each row of the new column.
138138
* @return An [InsertClause] for specifying the placement of the newly created column.
139139
*/
140140
@Interpretable("Insert1")
@@ -230,7 +230,7 @@ public fun <T> InsertClause<T>.under(column: ColumnSelector<T, *>): DataFrame<T>
230230
* df.insert(age).under(pathOf("info", "personal"))
231231
* ```
232232
*
233-
* @param columnPath The [ColumnPath] specifying the path to a column group in this [DataFrame]
233+
* @param [columnPath] The [ColumnPath] specifying the path to a column group in this [DataFrame]
234234
* under which the new column will be inserted.
235235
* @return A new [DataFrame] with the inserted column placed under the specified column group.
236236
*/
@@ -263,7 +263,7 @@ public fun <T> InsertClause<T>.under(column: KProperty<*>): DataFrame<T> = under
263263
* df.insert(age).under("info")
264264
* ```
265265
*
266-
* @param column The [name][String] of the column group in this [DataFrame].
266+
* @param [column] The [name][String] of the column group in this [DataFrame].
267267
* If the group does not exist, it will be created.
268268
* @return A new [DataFrame] with the inserted column placed under the specified column group.
269269
*/
@@ -294,7 +294,7 @@ public fun <T> InsertClause<T>.under(column: String): DataFrame<T> = under(pathO
294294
* val dfWithSum = df.insert("sum") { a + b }.after { stats.min }
295295
* ```
296296
*
297-
* @param column The [ColumnSelector] used to choose an existing column in this [DataFrame],
297+
* @param [column] The [ColumnSelector] used to choose an existing column in this [DataFrame],
298298
* after which the new column will be inserted.
299299
* @return A new [DataFrame] with the inserted column placed after the selected column.
300300
*/
@@ -318,7 +318,7 @@ public fun <T> InsertClause<T>.after(column: ColumnSelector<T, *>): DataFrame<T>
318318
* df.insert(age).after("name")
319319
* ```
320320
*
321-
* @param column The [String] name of the column in this [DataFrame]
321+
* @param [column] The [String] name of the column in this [DataFrame]
322322
* after which the new column will be inserted.
323323
* @return A new [DataFrame] with the inserted column placed after the specified column.
324324
*/
@@ -363,7 +363,7 @@ internal fun <T> InsertClause<T>.afterImpl(columnPath: ColumnPath): DataFrame<T>
363363
* df.insert(age).at(3)
364364
* ```
365365
*
366-
* @param position The [Int] index where the new column should be inserted.
366+
* @param [position] The [Int] index where the new column should be inserted.
367367
* Columns currently at this index and after will be shifted right.
368368
* @return A new [DataFrame] with the inserted column placed at the specified position.
369369
*/

0 commit comments

Comments
 (0)