Columns Selection DSL KDocs and missing API overloads #331
Conversation
…sl-docs # Conflicts: # core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/ColumnsSelectionDsl.kt # core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/ColumnsSelectionDsl.kt
…ion dsl with docs (still need to add tests)
added all overloads for col, colGroup, and frameCol in dsl with docs
…, kproperties including tests for all
Jolanrensen
changed the title
# Conflicts: # core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/ColumnsSelectionDsl.kt # core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/update.kt # core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/ColumnsSelectionDsl.kt
core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/constructors.kt
Outdated
Show resolved
Hide resolved
core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/constructors.kt
Outdated
Show resolved
Hide resolved
...generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/ColumnsSelectionDsl.kt
Outdated
Show resolved
Hide resolved
...generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/ColumnsSelectionDsl.kt
Outdated
Show resolved
Hide resolved
...generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/ColumnsSelectionDsl.kt
Outdated
Show resolved
Hide resolved
| } | ||
|
|
||
| df.select { | ||
| "name"["firstName", "lastName"] |
There was a problem hiding this comment.
it still looks more like "pathOf" for me than slicing
There was a problem hiding this comment.
pathOf would be "name"["firstName"]["lastName"]. I actually think this is kinda neat. It allows you to select multiple columns way down in a path: "some"["path"]["to"]["multiple", "columns"]
There was a problem hiding this comment.
I think it takes a bit more effort to "parse" this expression and recognize the difference and to understand that the result is multiple columns.
Here the difference is more obvious and it's still quite compact
"some"["path"]["to"].cols("multiple", "columns")
There was a problem hiding this comment.
Yeah for sure :) But again for completeness, should we remove it?
pathOf("path", "to")["a", "b"] doesn't look that wrong
There was a problem hiding this comment.
Maybe? I don't know, let's check how it looks in completion. How discoverable is this API, how many options there are
core/generated-sources/src/test/kotlin/org/jetbrains/kotlinx/dataframe/samples/api/Access.kt
Show resolved
Hide resolved
core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/constructors.kt
Outdated
Show resolved
Hide resolved
...ed-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/documentation/ColumnExpression.kt
Show resolved
Hide resolved
...ed-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/documentation/ColumnExpression.kt
Show resolved
Hide resolved
Adds docs surrounding the Column Selection DSLs
Depends on #318