Skip to content

Commit f5f222c

Browse files
rename kdocs fixes
1 parent 4158c17 commit f5f222c

File tree

1 file changed

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

1 file changed

+9
-4
lines changed

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

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,8 @@ import kotlin.reflect.KProperty
5050
* See [Selecting Columns][RenameSelectingOptions].
5151
*
5252
* For more information: {@include [DocumentationUrls.Rename]}
53+
*
54+
* See also [renameToCamelCase] which renames all columns to "camelCase" format.
5355
*/
5456
internal interface RenameDocs {
5557

@@ -65,16 +67,16 @@ internal interface RenameDocs {
6567
* {@include [DslGrammarLink]}
6668
* {@include [LineBreak]}
6769
*
68-
* **[`rename`][rename]**` { columnsSelector: `[`ColumnsSelector`][ColumnsSelector]` }`
70+
* [**`rename`**][rename]**` { `**`columnsSelector: `[`ColumnsSelector`][ColumnsSelector]` `**`}`**
6971
*
7072
* {@include [Indent]}
71-
* `| `__`.`__[**`into`**][RenameClause.into]`(name: `[`String`][String]`)`
73+
* `| `__`.`__[**`into`**][RenameClause.into]**`(`**`name: `[`String`][String]**`)`**
7274
*
7375
* {@include [Indent]}
74-
* `| `__`.`__[**`into`**][RenameClause.into]` { nameExpression: (`[`ColumnWithPath`][ColumnWithPath]`<C>) -> `[String]` }`
76+
* `| `__`.`__[**`into`**][RenameClause.into]**` { `**`nameExpression: (`[`ColumnWithPath`][ColumnWithPath]`) -> `[String]` `**`}`**
7577
*
7678
* {@include [Indent]}
77-
* `| `__`.`__[**`toCamelCase`**][RenameClause.toCamelCase]`()`
79+
* `| `__`.`__[**`toCamelCase`**][RenameClause.toCamelCase]**`()`**
7880
*/
7981
interface Grammar
8082
}
@@ -96,6 +98,8 @@ private interface CommonRenameDocs
9698
* This function allows renaming multiple columns in a single call by supplying a list of name pairs.
9799
* Each pair consists of the current column name and the desired new name.
98100
*
101+
* See also [renameToCamelCase] which renames all columns to "camelCase" format.
102+
*
99103
* Example:
100104
* ```
101105
* df.rename("oldName1" to "newName1", "oldName2" to "newName2")
@@ -200,6 +204,7 @@ public class RenameClause<T, C>(internal val df: DataFrame<T>, internal val colu
200204
* "UPPER_CASE_NAME -> upperCaseName"
201205
* ```
202206
*
207+
* @see [rename]
203208
* @return a [DataFrame] with column names converted to "camelCase" format.
204209
*/
205210
@Refine

0 commit comments

Comments
 (0)