Skip to content

Commit 5d0b16a

Browse files
undo move into deprecate + add kdocs
1 parent 92fabdd commit 5d0b16a

File tree

1 file changed

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

1 file changed

+13
-2
lines changed

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

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -407,9 +407,20 @@ public fun <T, C> MoveClause<T, C>.into(
407407
)
408408

409409
/**
410-
* Move a single selected column to top level with a new name
410+
* Moves the selected column, previously specified with [move],
411+
* to the top level of the [DataFrame] and assigns it a new name.
412+
*
413+
* For more information, see {@include [DocumentationUrls.Move]}.
414+
*
415+
* ### Example:
416+
* ```kotlin
417+
* // Move "info"."salary" column to the top level with a new name "income"
418+
* df.move { info.salary }.into("income")
419+
* ```
420+
*
421+
* @param column The new [String] name of the column after the move.
422+
* @return A new [DataFrame] with the column moved and renamed.
411423
*/
412-
@Deprecated(MESSAGE_SHORTCUT_1_0, ReplaceWith("into { pathOf(column) }"), DeprecationLevel.ERROR)
413424
@Refine
414425
@Interpretable("MoveInto0")
415426
public fun <T, C> MoveClause<T, C>.into(column: String): DataFrame<T> = pathOf(column).let { path -> into { path } }

0 commit comments

Comments
 (0)