diff --git a/KDOC_PREPROCESSING.md b/KDOC_PREPROCESSING.md index a387b09333..c4f145f8ab 100644 --- a/KDOC_PREPROCESSING.md +++ b/KDOC_PREPROCESSING.md @@ -695,7 +695,7 @@ function, interface, or class as HTML. The Markdown of the KDoc is rendered to HTML using [JetBrains/markdown](https://github.com/JetBrains/markdown) and, in the case of DataFrame, put in [./docs/StardustDocs/resources/snippets/kdocs](docs/StardustDocs/resources/snippets/kdocs). From there, the HTML can be included in any WriterSide page as an iFrame. -This can be done using our custom `` tag. +This can be done using our custom `` tag. An example of the result can be found in the [DataFrame documentation](https://kotlin.github.io/dataframe/columnselectors.html#full-dsl-grammar). diff --git a/core/src/test/kotlin/org/jetbrains/kotlinx/dataframe/explainer/SampleAggregator.kt b/core/src/test/kotlin/org/jetbrains/kotlinx/dataframe/explainer/SampleAggregator.kt index 5111bbe534..42119af445 100644 --- a/core/src/test/kotlin/org/jetbrains/kotlinx/dataframe/explainer/SampleAggregator.kt +++ b/core/src/test/kotlin/org/jetbrains/kotlinx/dataframe/explainer/SampleAggregator.kt @@ -9,7 +9,7 @@ fun main() { it.nameWithoutExtension.startsWith("org.jetbrains") } // org.ClassName.functionName_properties - // + // .groupBy { it.nameWithoutExtension.substringBefore("_") }.mapValues { (name, files) -> diff --git a/docs/StardustDocs/resources/snippets/kdocs/org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl.DslGrammar.ColumnGroupPartOfGrammar.ForHtml.html b/docs/StardustDocs/resources/snippets/kdocs/org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl.DslGrammar.ColumnGroupPartOfGrammar.ForHtml.html index 7fee56941c..a6c40ff1cf 100644 --- a/docs/StardustDocs/resources/snippets/kdocs/org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl.DslGrammar.ColumnGroupPartOfGrammar.ForHtml.html +++ b/docs/StardustDocs/resources/snippets/kdocs/org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl.DslGrammar.ColumnGroupPartOfGrammar.ForHtml.html @@ -43,6 +43,47 @@ color: #FFFFFFCC } +

columnGroup

    | [column, ..]

    | [{ condition }]

    | { colsSelector }

    | .allCols()

    | .allCols(Before|After|From|UpTo) ( (column) | { colSelector } )

    | .allColsExcept { colsSelector }

    | .allColsExcept(columnNoAccessor, ..)

    | .and (|{ columnOrSet }|)

    | (.col| .valueCol| .frameCol| .colGroup)[<T>](column | index)

    | (.cols| .valueCols| .frameCols| .colGroups) [ { condition } ]

    | .cols[<T>](column,.. |index,.. |indexRange)

    | .colsAtAnyDepth [ { condition } ]

    | .colsInGroups [ { condition } ]

    | .colsName(Starts|Ends)With(text[, ignoreCase])

    | .colsNameContains(text[, ignoreCase] | regex)

    | .colsOfKind(kind, ..) [ { condition } ]

    | .colsWithoutNulls()

    | .drop(Last)Cols(number)

    | .drop(Last)ColsWhile { condition }

    | .except { colsSelector }

    | .except(columnNoAccessor, ..)

    | (.firstCol| .lastCol| .singleCol) [ { condition } ]

    | .select { colsSelector }

    | .take(Last)Cols(number)

    | .take(Last)ColsWhile { condition }

    

singleColumn

    .colsOf<T> [ (kType) ] [ { condition } ]

    

columnGroupReference

    .colsOf<T>(kType) [ { condition } ]

diff --git a/docs/StardustDocs/resources/snippets/kdocs/org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl.DslGrammar.ColumnSetPartOfGrammar.ForHtml.html b/docs/StardustDocs/resources/snippets/kdocs/org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl.DslGrammar.ColumnSetPartOfGrammar.ForHtml.html index aa69ba1009..f739c5c493 100644 --- a/docs/StardustDocs/resources/snippets/kdocs/org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl.DslGrammar.ColumnSetPartOfGrammar.ForHtml.html +++ b/docs/StardustDocs/resources/snippets/kdocs/org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl.DslGrammar.ColumnSetPartOfGrammar.ForHtml.html @@ -43,6 +43,47 @@ color: #FFFFFFCC } +

columnSet

    [index]

    | [index,.. |indexRange]

    | [{ condition }]

    | .all()

    | .all(Before|After|From|UpTo) ( (column) | { condition } )

    | .and (|{ columnOrSet }|)

    | (.col| .valueCol| .frameCol| .colGroup)(index)

    | (.cols| .valueCols| .frameCols| .colGroups) [ { condition } ]

    | .cols(index,.. |indexRange)

    | .colsAtAnyDepth [ { condition } ]

    | .colsInGroups [ { condition } ]

    | .colsOf<T> [ (kType) ] [ { condition } ]

    | .colsOfKind(kind, ..) [ { condition } ]

    | .distinct()

    | .drop(Last)(number)

    | .drop(Last)While { condition }

    | except [ { ] columnsResolver [ } ]

    | except column

    | .except(column, ..)

    | .filter { condition }

    | (.first| .last| .single) [ { condition } ]

    | .name(Starts|Ends)With(text[, ignoreCase])

    | .nameContains(text[, ignoreCase] | regex)

    | .simplify()

    | .take(Last)(number)

    | .take(Last)While { condition }

    | .withoutNulls()

diff --git a/docs/StardustDocs/resources/snippets/kdocs/org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl.DslGrammar.DefinitionsPartOfGrammar.html b/docs/StardustDocs/resources/snippets/kdocs/org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl.DslGrammar.DefinitionsPartOfGrammar.html index 7a6c00541d..246171088a 100644 --- a/docs/StardustDocs/resources/snippets/kdocs/org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl.DslGrammar.DefinitionsPartOfGrammar.html +++ b/docs/StardustDocs/resources/snippets/kdocs/org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl.DslGrammar.DefinitionsPartOfGrammar.html @@ -43,6 +43,47 @@ color: #FFFFFFCC } +

columnGroupReference: String | KProperty<*> | ColumnPath

colSelector: ColumnSelector

colsSelector: ColumnsSelector

column: ColumnAccessor | String |KProperty<*> | ColumnPath

columnGroup: SingleColumn<DataRow<*>> | String | KProperty<* | DataRow<*>> | ColumnPath

columnNoAccessor: String | KProperty<*> | ColumnPath

columnOrSet: column | columnSet

columnSet: ColumnSet<*>

columnsResolver: ColumnsResolver

condition: ColumnFilter

expression: Column Expression

ignoreCase: Boolean

index: Int

indexRange: IntRange

infer: Infer

kind: ColumnKind

kType: KType

name: String

number: Int

regex: Regex

singleColumn: SingleColumn<DataRow<*>>

T: Column type

text: String

diff --git a/docs/StardustDocs/resources/snippets/kdocs/org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl.DslGrammar.PlainDslPartOfGrammar.html b/docs/StardustDocs/resources/snippets/kdocs/org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl.DslGrammar.PlainDslPartOfGrammar.html index 6304737bb8..8459107aa7 100644 --- a/docs/StardustDocs/resources/snippets/kdocs/org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl.DslGrammar.PlainDslPartOfGrammar.html +++ b/docs/StardustDocs/resources/snippets/kdocs/org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl.DslGrammar.PlainDslPartOfGrammar.html @@ -43,6 +43,47 @@ color: #FFFFFFCC } +

column .. column

| this/it[column,..]

| this/it[{ condition }]

| all()

| all(Before|After|From|UpTo) ( (column)|{ colSelector } )

| allExcept { colsSelector }

| allExcept(column, ..)

| columnOrSet and [ { ] columnOrSet [ } ]

| columnOrSet.and (|{ columnOrSet }|)

| (col| valueCol| frameCol| colGroup)[<T>](column | index)

| (cols| valueCols| frameCols| colGroups) [ { condition } ]

| cols[<T>](column,.. |index,.. |indexRange)

| colsAtAnyDepth [ { condition } ]

| colsInGroups [ { condition } ]

| colsOf<T> [ (kType) ] [ { condition } ]

| colsOfKind(kind, ..) [ { condition } ]

| drop(Last)(number)

| drop(Last)While { condition }

| expr([name,][infer]) { expression }

| (first| last| single) [ { condition } ]

| nameContains(text[, ignoreCase] | regex)

| name(Starts|Ends)With(text[, ignoreCase])

| column named/into column

| column(.named|.into)(column)

| none()

| take(Last)(number)

| take(Last)While { condition }

| withoutNulls()

diff --git a/docs/StardustDocs/topics/ColumnSelectors.md b/docs/StardustDocs/topics/ColumnSelectors.md index 91e9f94dc3..80635a4e5e 100644 --- a/docs/StardustDocs/topics/ColumnSelectors.md +++ b/docs/StardustDocs/topics/ColumnSelectors.md @@ -25,17 +25,17 @@ df.move { name.firstName and name.lastName }.after { city } **Definitions** - + - + - + - +