Rename kdocs #1402
Merged
Rename kdocs #1402
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# Conflicts: # core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/documentation/DocumentationUrls.kt
zaleslaw
approved these changes
Aug 22, 2025
| * - [toCamelCase()][RenameClause.toCamelCase] — renames all selected columns to `camelCase`. | ||
| * | ||
| * See [Grammar][RenameDocs.Grammar] for more details. | ||
| */ | ||
| @HasSchema(schemaArg = 0) |
There was a problem hiding this comment.
Looks like we need a catalogue / design doc with all annotations, invented this year @koperagen ?
Could you create a simple md doc with them?
There was a problem hiding this comment.
I recently updated the kdoc for HasSchema, should be clear now. They're all in the same file
Jolanrensen
approved these changes
Aug 22, 2025
| * Each pair consists of the current column name and the desired new name. | ||
| * | ||
| * Example: | ||
| * ``` |
There was a problem hiding this comment.
I'd still mark examples with kotlin or kt so the highlighting is correct
| * @param mappings A vararg of pairs where each pair consists of the original column name (`first`) | ||
| * and the new column name (`second`). | ||
| * @return A new [DataFrame] with the renamed columns. | ||
| */ | ||
| @Refine | ||
| @Interpretable("RenameMapping") | ||
| public fun <T> DataFrame<T>.rename(vararg mappings: Pair<String, String>): DataFrame<T> = |
There was a problem hiding this comment.
should this one be mentioned in the grammar as well?
There was a problem hiding this comment.
maybe also renameToCamelCase?
There was a problem hiding this comment.
I believe they're out of grammar. I mean we should mention them, but not as part of operation grammar
Jolanrensen
reviewed
Aug 22, 2025
core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/rename.kt
Outdated
Show resolved
Hide resolved
Jolanrensen
approved these changes
Aug 26, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
close #1388.