Skip to content

Commit 4945870

Browse files
JolanrensenJolanrensen
committed
updated Usage links across CsDSL
1 parent 8bd09c9 commit 4945870

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+901
-1185
lines changed

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

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -51,12 +51,15 @@ internal fun <T> ColumnsSelectionDsl<T>.asSingleColumn(): SingleColumn<DataRow<T
5151
public annotation class ColumnsSelectionDslMarker
5252

5353
/**
54+
* ## Columns Selection DSL
5455
* Referring to or expressing column(s) in the selection DSL can be done in several ways corresponding to all
5556
* [Access APIs][org.jetbrains.kotlinx.dataframe.documentation.AccessApi]:
5657
* TODO: [Issue #286](https://github.com/Kotlin/dataframe/issues/286)
5758
*
5859
* [See Column Selectors on the documentation website.](https://kotlin.github.io/dataframe/columnselectors.html)
5960
*
61+
* ### Check out: [Usage]
62+
*
6063
* Can be safely cast to [SingleColumn] across the library. It does not directly
6164
* implement it for DSL purposes.
6265
*
@@ -490,7 +493,7 @@ public interface ColumnsSelectionDsl<out T> : /* SingleColumn<DataRow<T>> */
490493
*
491494
* The [invoke][org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl.invoke] operator is overloaded to work as a shortcut for this method.
492495
*
493-
* See [Usage][org.jetbrains.kotlinx.dataframe.api.SelectColumnsSelectionDsl.Usage] for how to use [select][org.jetbrains.kotlinx.dataframe.api.SelectColumnsSelectionDsl.select].
496+
* ### Check out: [Usage][org.jetbrains.kotlinx.dataframe.api.SelectColumnsSelectionDsl.Usage]
494497
*
495498
* #### For example:
496499
*
@@ -532,7 +535,7 @@ public interface ColumnsSelectionDsl<out T> : /* SingleColumn<DataRow<T>> */
532535
*
533536
* The [invoke][org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl.invoke] operator is overloaded to work as a shortcut for this method.
534537
*
535-
* See [Usage][org.jetbrains.kotlinx.dataframe.api.SelectColumnsSelectionDsl.Usage] for how to use [select][org.jetbrains.kotlinx.dataframe.api.SelectColumnsSelectionDsl.select].
538+
* ### Check out: [Usage][org.jetbrains.kotlinx.dataframe.api.SelectColumnsSelectionDsl.Usage]
536539
*
537540
* #### For example:
538541
*
@@ -581,7 +584,7 @@ public interface ColumnsSelectionDsl<out T> : /* SingleColumn<DataRow<T>> */
581584
*
582585
* The [invoke][org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl.invoke] operator is overloaded to work as a shortcut for this method.
583586
*
584-
* See [Usage][org.jetbrains.kotlinx.dataframe.api.SelectColumnsSelectionDsl.Usage] for how to use [select][org.jetbrains.kotlinx.dataframe.api.SelectColumnsSelectionDsl.select].
587+
* ### Check out: [Usage][org.jetbrains.kotlinx.dataframe.api.SelectColumnsSelectionDsl.Usage]
585588
*
586589
* #### For example:
587590
*
@@ -625,7 +628,7 @@ public interface ColumnsSelectionDsl<out T> : /* SingleColumn<DataRow<T>> */
625628
*
626629
* The [invoke][org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl.invoke] operator is overloaded to work as a shortcut for this method.
627630
*
628-
* See [Usage][org.jetbrains.kotlinx.dataframe.api.SelectColumnsSelectionDsl.Usage] for how to use [select][org.jetbrains.kotlinx.dataframe.api.SelectColumnsSelectionDsl.select].
631+
* ### Check out: [Usage][org.jetbrains.kotlinx.dataframe.api.SelectColumnsSelectionDsl.Usage]
629632
*
630633
* #### For example:
631634
*
@@ -667,7 +670,7 @@ public interface ColumnsSelectionDsl<out T> : /* SingleColumn<DataRow<T>> */
667670
*
668671
* The [invoke][org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl.invoke] operator is overloaded to work as a shortcut for this method.
669672
*
670-
* See [Usage][org.jetbrains.kotlinx.dataframe.api.SelectColumnsSelectionDsl.Usage] for how to use [select][org.jetbrains.kotlinx.dataframe.api.SelectColumnsSelectionDsl.select].
673+
* ### Check out: [Usage][org.jetbrains.kotlinx.dataframe.api.SelectColumnsSelectionDsl.Usage]
671674
*
672675
* #### For example:
673676
*

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

Lines changed: 160 additions & 466 deletions
Large diffs are not rendered by default.

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

Lines changed: 72 additions & 1 deletion
Large diffs are not rendered by default.

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

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -111,9 +111,9 @@ public interface AndColumnsSelectionDsl {
111111
*
112112
* You can even mix and match any [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi]!
113113
*
114-
* Check out the [Usage] for how to use [and].
114+
* ### Check out: [Usage]
115115
*
116-
* ### Examples:
116+
* #### Examples:
117117
*
118118
* `df.`[groupBy][DataFrame.groupBy]` { "colA" `[and][String.and]` colB }`
119119
*
@@ -149,9 +149,9 @@ public interface AndColumnsSelectionDsl {
149149
*
150150
* You can even mix and match any [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi]!
151151
*
152-
* Check out the [Usage][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Usage] for how to use [and][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.and].
152+
* ### Check out: [Usage][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Usage]
153153
*
154-
* ### Examples:
154+
* #### Examples:
155155
*
156156
* `df.`[groupBy][org.jetbrains.kotlinx.dataframe.DataFrame.groupBy]` { "colA" `[and][kotlin.String.and]` colB }`
157157
*
@@ -184,9 +184,9 @@ public interface AndColumnsSelectionDsl {
184184
*
185185
* You can even mix and match any [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi]!
186186
*
187-
* Check out the [Usage][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Usage] for how to use [and][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.and].
187+
* ### Check out: [Usage][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Usage]
188188
*
189-
* ### Examples:
189+
* #### Examples:
190190
*
191191
* `df.`[groupBy][org.jetbrains.kotlinx.dataframe.DataFrame.groupBy]` { "colA" `[and][kotlin.String.and]` colB }`
192192
*
@@ -216,9 +216,9 @@ public interface AndColumnsSelectionDsl {
216216
*
217217
* You can even mix and match any [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi]!
218218
*
219-
* Check out the [Usage][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Usage] for how to use [and][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.and].
219+
* ### Check out: [Usage][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Usage]
220220
*
221-
* ### Examples:
221+
* #### Examples:
222222
*
223223
* `df.`[groupBy][org.jetbrains.kotlinx.dataframe.DataFrame.groupBy]` { "colA" `[and][kotlin.String.and]` colB }`
224224
*
@@ -248,9 +248,9 @@ public interface AndColumnsSelectionDsl {
248248
*
249249
* You can even mix and match any [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi]!
250250
*
251-
* Check out the [Usage][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Usage] for how to use [and][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.and].
251+
* ### Check out: [Usage][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Usage]
252252
*
253-
* ### Examples:
253+
* #### Examples:
254254
*
255255
* `df.`[groupBy][org.jetbrains.kotlinx.dataframe.DataFrame.groupBy]` { "colA" `[and][kotlin.String.and]` colB }`
256256
*
@@ -280,9 +280,9 @@ public interface AndColumnsSelectionDsl {
280280
*
281281
* You can even mix and match any [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi]!
282282
*
283-
* Check out the [Usage][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Usage] for how to use [and][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.and].
283+
* ### Check out: [Usage][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Usage]
284284
*
285-
* ### Examples:
285+
* #### Examples:
286286
*
287287
* `df.`[groupBy][org.jetbrains.kotlinx.dataframe.DataFrame.groupBy]` { "colA" `[and][kotlin.String.and]` colB }`
288288
*
@@ -317,9 +317,9 @@ public interface AndColumnsSelectionDsl {
317317
*
318318
* You can even mix and match any [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi]!
319319
*
320-
* Check out the [Usage][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Usage] for how to use [and][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.and].
320+
* ### Check out: [Usage][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Usage]
321321
*
322-
* ### Examples:
322+
* #### Examples:
323323
*
324324
* `df.`[groupBy][org.jetbrains.kotlinx.dataframe.DataFrame.groupBy]` { "colA" `[and][kotlin.String.and]` colB }`
325325
*
@@ -352,9 +352,9 @@ public interface AndColumnsSelectionDsl {
352352
*
353353
* You can even mix and match any [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi]!
354354
*
355-
* Check out the [Usage][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Usage] for how to use [and][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.and].
355+
* ### Check out: [Usage][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Usage]
356356
*
357-
* ### Examples:
357+
* #### Examples:
358358
*
359359
* `df.`[groupBy][org.jetbrains.kotlinx.dataframe.DataFrame.groupBy]` { "colA" `[and][kotlin.String.and]` colB }`
360360
*
@@ -384,9 +384,9 @@ public interface AndColumnsSelectionDsl {
384384
*
385385
* You can even mix and match any [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi]!
386386
*
387-
* Check out the [Usage][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Usage] for how to use [and][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.and].
387+
* ### Check out: [Usage][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Usage]
388388
*
389-
* ### Examples:
389+
* #### Examples:
390390
*
391391
* `df.`[groupBy][org.jetbrains.kotlinx.dataframe.DataFrame.groupBy]` { "colA" `[and][kotlin.String.and]` colB }`
392392
*
@@ -416,9 +416,9 @@ public interface AndColumnsSelectionDsl {
416416
*
417417
* You can even mix and match any [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi]!
418418
*
419-
* Check out the [Usage][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Usage] for how to use [and][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.and].
419+
* ### Check out: [Usage][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Usage]
420420
*
421-
* ### Examples:
421+
* #### Examples:
422422
*
423423
* `df.`[groupBy][org.jetbrains.kotlinx.dataframe.DataFrame.groupBy]` { "colA" `[and][kotlin.String.and]` colB }`
424424
*
@@ -448,9 +448,9 @@ public interface AndColumnsSelectionDsl {
448448
*
449449
* You can even mix and match any [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi]!
450450
*
451-
* Check out the [Usage][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Usage] for how to use [and][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.and].
451+
* ### Check out: [Usage][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Usage]
452452
*
453-
* ### Examples:
453+
* #### Examples:
454454
*
455455
* `df.`[groupBy][org.jetbrains.kotlinx.dataframe.DataFrame.groupBy]` { "colA" `[and][kotlin.String.and]` colB }`
456456
*
@@ -485,9 +485,9 @@ public interface AndColumnsSelectionDsl {
485485
*
486486
* You can even mix and match any [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi]!
487487
*
488-
* Check out the [Usage][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Usage] for how to use [and][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.and].
488+
* ### Check out: [Usage][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Usage]
489489
*
490-
* ### Examples:
490+
* #### Examples:
491491
*
492492
* `df.`[groupBy][org.jetbrains.kotlinx.dataframe.DataFrame.groupBy]` { "colA" `[and][kotlin.String.and]` colB }`
493493
*
@@ -520,9 +520,9 @@ public interface AndColumnsSelectionDsl {
520520
*
521521
* You can even mix and match any [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi]!
522522
*
523-
* Check out the [Usage][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Usage] for how to use [and][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.and].
523+
* ### Check out: [Usage][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Usage]
524524
*
525-
* ### Examples:
525+
* #### Examples:
526526
*
527527
* `df.`[groupBy][org.jetbrains.kotlinx.dataframe.DataFrame.groupBy]` { "colA" `[and][kotlin.String.and]` colB }`
528528
*
@@ -552,9 +552,9 @@ public interface AndColumnsSelectionDsl {
552552
*
553553
* You can even mix and match any [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi]!
554554
*
555-
* Check out the [Usage][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Usage] for how to use [and][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.and].
555+
* ### Check out: [Usage][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Usage]
556556
*
557-
* ### Examples:
557+
* #### Examples:
558558
*
559559
* `df.`[groupBy][org.jetbrains.kotlinx.dataframe.DataFrame.groupBy]` { "colA" `[and][kotlin.String.and]` colB }`
560560
*
@@ -585,9 +585,9 @@ public interface AndColumnsSelectionDsl {
585585
*
586586
* You can even mix and match any [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi]!
587587
*
588-
* Check out the [Usage][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Usage] for how to use [and][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.and].
588+
* ### Check out: [Usage][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Usage]
589589
*
590-
* ### Examples:
590+
* #### Examples:
591591
*
592592
* `df.`[groupBy][org.jetbrains.kotlinx.dataframe.DataFrame.groupBy]` { "colA" `[and][kotlin.String.and]` colB }`
593593
*
@@ -617,9 +617,9 @@ public interface AndColumnsSelectionDsl {
617617
*
618618
* You can even mix and match any [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi]!
619619
*
620-
* Check out the [Usage][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Usage] for how to use [and][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.and].
620+
* ### Check out: [Usage][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Usage]
621621
*
622-
* ### Examples:
622+
* #### Examples:
623623
*
624624
* `df.`[groupBy][org.jetbrains.kotlinx.dataframe.DataFrame.groupBy]` { "colA" `[and][kotlin.String.and]` colB }`
625625
*

0 commit comments

Comments
 (0)