Skip to content

Commit 4180389

Browse files
committed
updating kdocs
1 parent 4945870 commit 4180389

File tree

24 files changed

+1220
-1091
lines changed

24 files changed

+1220
-1091
lines changed

core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/aliases.kt

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
package org.jetbrains.kotlinx.dataframe
22

33
import org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl
4+
import org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDslLink
45
import org.jetbrains.kotlinx.dataframe.columns.BaseColumn
56
import org.jetbrains.kotlinx.dataframe.columns.ColumnAccessor
67
import org.jetbrains.kotlinx.dataframe.columns.ColumnReference
@@ -86,7 +87,7 @@ public typealias RowColumnExpression<T, C, R> = (row: DataRow<T>, col: DataColum
8687
public typealias ColumnExpression<C, R> = Selector<DataColumn<C>, R>
8788

8889
/**
89-
* [ColumnSelector] is used to express or select a single column, represented by [SingleColumn]`<C>`, using the
90+
* A [ColumnSelector] is used to express or select a single column, represented by [SingleColumn]`<C>`, using the
9091
* context of [ColumnsSelectionDsl]`<T>` as `this` and `it`.
9192
*
9293
* Shorthand for:
@@ -97,9 +98,11 @@ public typealias ColumnExpression<C, R> = Selector<DataColumn<C>, R>
9798
public typealias ColumnSelector<T, C> = Selector<ColumnsSelectionDsl<T>, SingleColumn<C>>
9899

99100
/**
100-
* [ColumnsSelector] is used to express or select one or multiple columns, represented by [ColumnsResolver]`<C>`,
101+
* A [ColumnsSelector] is used to express or select one or multiple columns, represented by [ColumnsResolver]`<C>`,
101102
* using the context of [ColumnsSelectionDsl]`<T>` as `this` and `it`.
102103
*
104+
* See [ColumnsSelectionDsl] for more information.
105+
*
103106
* Shorthand for:
104107
* ```kotlin
105108
* ColumnsSelectionDsl<T>.(it: ColumnsSelectionDsl<T>) -> ColumnsResolver<C>

core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/ColumnSelectionDsl.kt

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,6 @@ import kotlin.reflect.KProperty
1515
/** [Column Selection DSL][ColumnSelectionDsl] */
1616
internal interface ColumnSelectionDslLink
1717

18-
/** Referring to or expressing column(s) in the selection DSL can be done in several ways corresponding to all
19-
* [Access APIs][org.jetbrains.kotlinx.dataframe.documentation.AccessApi]:
20-
* TODO: [Issue #286](https://github.com/Kotlin/dataframe/issues/286)
21-
*
22-
* [See Column Selectors on the documentation website.](https://kotlin.github.io/dataframe/columnselectors.html) */
2318
public interface ColumnSelectionDsl<out T> : ColumnsContainer<T> {
2419

2520
/**

core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/ColumnsSelectionDsl.kt

Lines changed: 20 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,13 @@ import org.jetbrains.kotlinx.dataframe.ColumnsSelector
44
import org.jetbrains.kotlinx.dataframe.DataColumn
55
import org.jetbrains.kotlinx.dataframe.DataFrame
66
import org.jetbrains.kotlinx.dataframe.DataRow
7-
import org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl.Usage
87
import org.jetbrains.kotlinx.dataframe.columns.ColumnPath
98
import org.jetbrains.kotlinx.dataframe.columns.ColumnSet
109
import org.jetbrains.kotlinx.dataframe.columns.ColumnsResolver
1110
import org.jetbrains.kotlinx.dataframe.columns.SingleColumn
12-
import org.jetbrains.kotlinx.dataframe.documentation.AccessApi
13-
import org.jetbrains.kotlinx.dataframe.documentation.DocumentationUrls
1411
import org.jetbrains.kotlinx.dataframe.documentation.Indent
1512
import org.jetbrains.kotlinx.dataframe.documentation.LineBreak
13+
import org.jetbrains.kotlinx.dataframe.documentation.SelectingColumns
1614
import org.jetbrains.kotlinx.dataframe.documentation.UsageTemplateColumnsSelectionDsl
1715
import org.jetbrains.kotlinx.dataframe.documentation.UsageTemplateColumnsSelectionDsl.UsageTemplate
1816
import org.jetbrains.kotlinx.dataframe.impl.columns.ColumnsList
@@ -21,20 +19,6 @@ import org.jetbrains.kotlinx.dataframe.util.COL_SELECT_DSL_LIST_DATACOLUMN_GET_R
2119
import kotlin.experimental.ExperimentalTypeInference
2220
import kotlin.reflect.KProperty
2321

24-
/**
25-
* Referring to or expressing column(s) in the selection DSL can be done in several ways corresponding to all
26-
* [Access APIs][AccessApi]:
27-
* TODO: [Issue #286](https://github.com/Kotlin/dataframe/issues/286)
28-
*
29-
* [See Column Selectors on the documentation website.](https://kotlin.github.io/dataframe/columnselectors.html)
30-
*/
31-
private interface CommonColumnSelectionDocs
32-
33-
/**
34-
*
35-
*/
36-
private interface CommonColumnSelectionExamples
37-
3822
/** [Columns Selection DSL][ColumnsSelectionDsl] */
3923
internal interface ColumnsSelectionDslLink
4024

@@ -52,18 +36,30 @@ public annotation class ColumnsSelectionDslMarker
5236

5337
/**
5438
* ## Columns Selection DSL
55-
* Referring to or expressing column(s) in the selection DSL can be done in several ways corresponding to all
56-
* [Access APIs][org.jetbrains.kotlinx.dataframe.documentation.AccessApi]:
57-
* TODO: [Issue #286](https://github.com/Kotlin/dataframe/issues/286)
39+
* Select or express columns using the [Columns Selection DSL][org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl].
40+
* (Any (combination of) [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi]).
41+
*
42+
* This DSL comes in the form a [Columns Selector][org.jetbrains.kotlinx.dataframe.ColumnsSelector] lambda,
43+
* which operates on the [Columns Selection DSL][org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl] and
44+
* expects you to return a [ColumnsResolver][org.jetbrains.kotlinx.dataframe.columns.ColumnsResolver]; an entity formed by calling any (combination) of the functions
45+
* in the DSL that is or can be resolved into one or more columns.
46+
* ### Check out: [Columns Selection DSL Usage][org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl.Usage]
47+
*
48+
* &nbsp;&nbsp;&nbsp;&nbsp;
5849
*
5950
* [See Column Selectors on the documentation website.](https://kotlin.github.io/dataframe/columnselectors.html)
6051
*
61-
* ### Check out: [Usage]
52+
* #### For example:
53+
*
54+
* `df.`select` { length `[and][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.and]` age }`
55+
*
56+
* `df.`select` { `[cols][org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl.cols]`(1..5) }`
57+
*
58+
* `df.`select` { `[colsOf][org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl.colsOf]`<`[Double][Double]`>() }`
59+
*
60+
*
6261
*
63-
* Can be safely cast to [SingleColumn] across the library. It does not directly
64-
* implement it for DSL purposes.
6562
*
66-
* See [Usage] for the DSL Grammar of the ColumnsSelectionDsl.
6763
*/
6864
@ColumnsSelectionDslMarker
6965
public interface ColumnsSelectionDsl<out T> : /* SingleColumn<DataRow<T>> */

0 commit comments

Comments
 (0)