search

Kotlin / dataframe

Structured data processing in Kotlin
https://kotlin.github.io/dataframe/overview.html
Apache License 2.0
768 stars 48 forks source link

Column Selector Grammar in docs #619

Closed Jolanrensen closed 3 weeks ago

Jolanrensen commented 3 months ago

Works on https://github.com/Kotlin/dataframe/issues/570

Started the process for writing docs for the columns selection DSL. Since the latest doc preprocessor update we are able to @ExportAsHtml any KDoc and this PR aims to export the DSL Grammar from the ColumnsSelectionDSL directly on Writerside.

~This makes it dependent on previous KDoc fixes in https://github.com/Kotlin/dataframe/pull/613~

Aside from those general KDoc fixes, this PR removes some nbsp from type definitions (as those don't align in generated HTML), and it splits the ColumnsSelection DSL grammar in separate interfaces so they can be imported into writerside separately and put in a table (fixed by https://github.com/Kotlin/dataframe/pull/618).

zaleslaw commented 1 month ago

@Jolanrensen what is the status of this PR?

Jolanrensen commented 1 month ago

It's probably ready to be merged:

image

I've limited this PR to just the inclusion of the grammar in the docs. I'll expand upon the documentation in a new PR :)