Skip to content

Commit 12f620a

Browse files
JolanrensenJolanrensen
committed
renaming all "Usage" docs to "Grammar"
1 parent f228165 commit 12f620a

Some content is hidden

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

75 files changed

+2369
-2348
lines changed

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

Lines changed: 95 additions & 96 deletions
Large diffs are not rendered by default.

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

Lines changed: 57 additions & 48 deletions
Large diffs are not rendered by default.

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

Lines changed: 182 additions & 183 deletions
Large diffs are not rendered by default.

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

Lines changed: 57 additions & 58 deletions
Large diffs are not rendered by default.

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

Lines changed: 37 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,41 @@
11
package org.jetbrains.kotlinx.dataframe.api
22

3-
import org.jetbrains.kotlinx.dataframe.ColumnsSelector
43
import org.jetbrains.kotlinx.dataframe.DataColumn
54
import org.jetbrains.kotlinx.dataframe.DataFrame
5+
import org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Grammar
6+
import org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Grammar.InfixName
7+
import org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Grammar.Name
68
import org.jetbrains.kotlinx.dataframe.columns.ColumnPath
79
import org.jetbrains.kotlinx.dataframe.columns.ColumnReference
810
import org.jetbrains.kotlinx.dataframe.columns.ColumnSet
911
import org.jetbrains.kotlinx.dataframe.columns.ColumnsResolver
1012
import org.jetbrains.kotlinx.dataframe.columns.SingleColumn
1113
import org.jetbrains.kotlinx.dataframe.documentation.AccessApiLink
1214
import org.jetbrains.kotlinx.dataframe.documentation.DoubleIndent
15+
import org.jetbrains.kotlinx.dataframe.documentation.DslGrammarTemplateColumnsSelectionDsl.DslGrammarTemplate
1316
import org.jetbrains.kotlinx.dataframe.documentation.Indent
1417
import org.jetbrains.kotlinx.dataframe.documentation.LineBreak
15-
import org.jetbrains.kotlinx.dataframe.documentation.UsageTemplateColumnsSelectionDsl.UsageTemplate
1618
import org.jetbrains.kotlinx.dataframe.impl.columns.ColumnsList
1719
import kotlin.reflect.KProperty
1820

1921
// region ColumnsSelectionDsl
2022

2123
/**
22-
* See [Usage]
24+
* See [Grammar]
2325
*/
2426
public interface AndColumnsSelectionDsl {
2527

2628
/**
27-
* ## And Operator Usage
29+
* ## And Operator Grammar
2830
*
2931
*
32+
*     
3033
*
34+
* [(What is this notation?)][org.jetbrains.kotlinx.dataframe.documentation.DslGrammar]
3135
*     
3236
*
33-
* `columnSet: `[ColumnSet][org.jetbrains.kotlinx.dataframe.columns.ColumnSet]`<*>`
37+
* ### Definitions:
38+
* `columnSet: `[ColumnSet][org.jetbrains.kotlinx.dataframe.columns.ColumnSet]`<*>`
3439
*
3540
* &nbsp;&nbsp;&nbsp;&nbsp;
3641
*
@@ -48,50 +53,46 @@ public interface AndColumnsSelectionDsl {
4853
*
4954
* &nbsp;&nbsp;&nbsp;&nbsp;
5055
*
51-
* `columnOrSet: `[column][org.jetbrains.kotlinx.dataframe.documentation.UsageTemplateColumnsSelectionDsl.UsageTemplate.ColumnDef]` | `[columnSet][org.jetbrains.kotlinx.dataframe.documentation.UsageTemplateColumnsSelectionDsl.UsageTemplate.ColumnSetDef]
56+
* `columnOrSet: `[column][org.jetbrains.kotlinx.dataframe.documentation.DslGrammarTemplateColumnsSelectionDsl.DslGrammarTemplate.ColumnDef]` | `[columnSet][org.jetbrains.kotlinx.dataframe.documentation.DslGrammarTemplateColumnsSelectionDsl.DslGrammarTemplate.ColumnSetDef]
5257
*
5358
* &nbsp;&nbsp;&nbsp;&nbsp;
5459
*
55-
* ### In the [ColumnsSelectionDsl][org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl]:
60+
* ### What can be called directly in the [Columns Selection DSL][org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl]:
5661
*
5762
*
5863
* &nbsp;&nbsp;&nbsp;&nbsp;
5964
*
60-
* [columnOrSet][org.jetbrains.kotlinx.dataframe.documentation.UsageTemplateColumnsSelectionDsl.UsageTemplate.ColumnOrColumnSetDef] [**and**][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.and]` [ `**`{`**` ] `[columnOrSet][org.jetbrains.kotlinx.dataframe.documentation.UsageTemplateColumnsSelectionDsl.UsageTemplate.ColumnOrColumnSetDef]` [ `**`}`**` ] `
65+
* [columnOrSet][org.jetbrains.kotlinx.dataframe.documentation.DslGrammarTemplateColumnsSelectionDsl.DslGrammarTemplate.ColumnOrColumnSetDef] [**and**][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.and]` [ `**`{`**` ] `[columnOrSet][org.jetbrains.kotlinx.dataframe.documentation.DslGrammarTemplateColumnsSelectionDsl.DslGrammarTemplate.ColumnOrColumnSetDef]` [ `**`}`**` ] `
6166
*
62-
* `| `[columnOrSet][org.jetbrains.kotlinx.dataframe.documentation.UsageTemplateColumnsSelectionDsl.UsageTemplate.ColumnOrColumnSetDef].[**and**][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.and] **`(`**`|`**`{ `**[columnOrSet][org.jetbrains.kotlinx.dataframe.documentation.UsageTemplateColumnsSelectionDsl.UsageTemplate.ColumnOrColumnSetDef]**` }`**`|`**`)`**
67+
* `| `[columnOrSet][org.jetbrains.kotlinx.dataframe.documentation.DslGrammarTemplateColumnsSelectionDsl.DslGrammarTemplate.ColumnOrColumnSetDef].[**and**][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.and] **`(`**`|`**`{ `**[columnOrSet][org.jetbrains.kotlinx.dataframe.documentation.DslGrammarTemplateColumnsSelectionDsl.DslGrammarTemplate.ColumnOrColumnSetDef]**` }`**`|`**`)`**
6368
*
6469
* &nbsp;&nbsp;&nbsp;&nbsp;
6570
*
66-
* ### On a [ColumnSet][org.jetbrains.kotlinx.dataframe.columns.ColumnSet]:
71+
* ### What can be called on a [ColumnSet][org.jetbrains.kotlinx.dataframe.columns.ColumnSet]:
6772
*
6873
*
6974
* &nbsp;&nbsp;&nbsp;&nbsp;
7075
*
71-
* [columnSet][org.jetbrains.kotlinx.dataframe.documentation.UsageTemplateColumnsSelectionDsl.UsageTemplate.ColumnSetDef]
76+
* [columnSet][org.jetbrains.kotlinx.dataframe.documentation.DslGrammarTemplateColumnsSelectionDsl.DslGrammarTemplate.ColumnSetDef]
7277
*
73-
* &nbsp;&nbsp;&nbsp;&nbsp;.[**and**][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.and] **`(`**`|`**`{ `**[columnOrSet][org.jetbrains.kotlinx.dataframe.documentation.UsageTemplateColumnsSelectionDsl.UsageTemplate.ColumnOrColumnSetDef]**` }`**`|`**`)`**
78+
* &nbsp;&nbsp;&nbsp;&nbsp;.[**and**][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.and] **`(`**`|`**`{ `**[columnOrSet][org.jetbrains.kotlinx.dataframe.documentation.DslGrammarTemplateColumnsSelectionDsl.DslGrammarTemplate.ColumnOrColumnSetDef]**` }`**`|`**`)`**
7479
*
7580
* &nbsp;&nbsp;&nbsp;&nbsp;
7681
*
77-
* ### On a column group reference:
82+
* ### What can be called on a [Column Group (reference)][org.jetbrains.kotlinx.dataframe.documentation.DslGrammarTemplateColumnsSelectionDsl.DslGrammarTemplate.ColumnGroupDef]:
7883
*
7984
*
8085
* &nbsp;&nbsp;&nbsp;&nbsp;
8186
*
82-
* [columnGroup][org.jetbrains.kotlinx.dataframe.documentation.UsageTemplateColumnsSelectionDsl.UsageTemplate.ColumnGroupDef]
83-
*
84-
* &nbsp;&nbsp;&nbsp;&nbsp;.[**and**][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.and] **`(`**`|`**`{ `**[columnOrSet][org.jetbrains.kotlinx.dataframe.documentation.UsageTemplateColumnsSelectionDsl.UsageTemplate.ColumnOrColumnSetDef]**` }`**`|`**`)`**
87+
* [columnGroup][org.jetbrains.kotlinx.dataframe.documentation.DslGrammarTemplateColumnsSelectionDsl.DslGrammarTemplate.ColumnGroupDef]
8588
*
89+
* &nbsp;&nbsp;&nbsp;&nbsp;.[**and**][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.and] **`(`**`|`**`{ `**[columnOrSet][org.jetbrains.kotlinx.dataframe.documentation.DslGrammarTemplateColumnsSelectionDsl.DslGrammarTemplate.ColumnOrColumnSetDef]**` }`**`|`**`)`**
8690
*
8791
*
8892
*
8993
*
9094
*
9195
*
92-
* &nbsp;&nbsp;&nbsp;&nbsp;
93-
*
94-
* [(What is this notation?)][org.jetbrains.kotlinx.dataframe.documentation.DslGrammar]
9596
*
9697
*
9798
*
@@ -100,7 +101,7 @@ public interface AndColumnsSelectionDsl {
100101
*
101102
*
102103
*/
103-
public interface Usage {
104+
public interface Grammar {
104105

105106
/** [**and**][ColumnsSelectionDsl.and] */
106107
public interface InfixName
@@ -115,7 +116,7 @@ public interface AndColumnsSelectionDsl {
115116
*
116117
* You can even mix and match any [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi]!
117118
*
118-
* ### Check out: [Usage]
119+
* ### Check out: [Grammar]
119120
*
120121
* #### Examples:
121122
*
@@ -153,7 +154,7 @@ public interface AndColumnsSelectionDsl {
153154
*
154155
* You can even mix and match any [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi]!
155156
*
156-
* ### Check out: [Usage][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Usage]
157+
* ### Check out: [Grammar][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Grammar]
157158
*
158159
* #### Examples:
159160
*
@@ -188,7 +189,7 @@ public interface AndColumnsSelectionDsl {
188189
*
189190
* You can even mix and match any [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi]!
190191
*
191-
* ### Check out: [Usage][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Usage]
192+
* ### Check out: [Grammar][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Grammar]
192193
*
193194
* #### Examples:
194195
*
@@ -220,7 +221,7 @@ public interface AndColumnsSelectionDsl {
220221
*
221222
* You can even mix and match any [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi]!
222223
*
223-
* ### Check out: [Usage][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Usage]
224+
* ### Check out: [Grammar][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Grammar]
224225
*
225226
* #### Examples:
226227
*
@@ -252,7 +253,7 @@ public interface AndColumnsSelectionDsl {
252253
*
253254
* You can even mix and match any [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi]!
254255
*
255-
* ### Check out: [Usage][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Usage]
256+
* ### Check out: [Grammar][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Grammar]
256257
*
257258
* #### Examples:
258259
*
@@ -284,7 +285,7 @@ public interface AndColumnsSelectionDsl {
284285
*
285286
* You can even mix and match any [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi]!
286287
*
287-
* ### Check out: [Usage][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Usage]
288+
* ### Check out: [Grammar][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Grammar]
288289
*
289290
* #### Examples:
290291
*
@@ -321,7 +322,7 @@ public interface AndColumnsSelectionDsl {
321322
*
322323
* You can even mix and match any [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi]!
323324
*
324-
* ### Check out: [Usage][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Usage]
325+
* ### Check out: [Grammar][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Grammar]
325326
*
326327
* #### Examples:
327328
*
@@ -356,7 +357,7 @@ public interface AndColumnsSelectionDsl {
356357
*
357358
* You can even mix and match any [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi]!
358359
*
359-
* ### Check out: [Usage][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Usage]
360+
* ### Check out: [Grammar][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Grammar]
360361
*
361362
* #### Examples:
362363
*
@@ -388,7 +389,7 @@ public interface AndColumnsSelectionDsl {
388389
*
389390
* You can even mix and match any [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi]!
390391
*
391-
* ### Check out: [Usage][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Usage]
392+
* ### Check out: [Grammar][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Grammar]
392393
*
393394
* #### Examples:
394395
*
@@ -420,7 +421,7 @@ public interface AndColumnsSelectionDsl {
420421
*
421422
* You can even mix and match any [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi]!
422423
*
423-
* ### Check out: [Usage][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Usage]
424+
* ### Check out: [Grammar][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Grammar]
424425
*
425426
* #### Examples:
426427
*
@@ -452,7 +453,7 @@ public interface AndColumnsSelectionDsl {
452453
*
453454
* You can even mix and match any [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi]!
454455
*
455-
* ### Check out: [Usage][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Usage]
456+
* ### Check out: [Grammar][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Grammar]
456457
*
457458
* #### Examples:
458459
*
@@ -489,7 +490,7 @@ public interface AndColumnsSelectionDsl {
489490
*
490491
* You can even mix and match any [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi]!
491492
*
492-
* ### Check out: [Usage][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Usage]
493+
* ### Check out: [Grammar][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Grammar]
493494
*
494495
* #### Examples:
495496
*
@@ -524,7 +525,7 @@ public interface AndColumnsSelectionDsl {
524525
*
525526
* You can even mix and match any [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi]!
526527
*
527-
* ### Check out: [Usage][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Usage]
528+
* ### Check out: [Grammar][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Grammar]
528529
*
529530
* #### Examples:
530531
*
@@ -556,7 +557,7 @@ public interface AndColumnsSelectionDsl {
556557
*
557558
* You can even mix and match any [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi]!
558559
*
559-
* ### Check out: [Usage][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Usage]
560+
* ### Check out: [Grammar][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Grammar]
560561
*
561562
* #### Examples:
562563
*
@@ -589,7 +590,7 @@ public interface AndColumnsSelectionDsl {
589590
*
590591
* You can even mix and match any [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi]!
591592
*
592-
* ### Check out: [Usage][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Usage]
593+
* ### Check out: [Grammar][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Grammar]
593594
*
594595
* #### Examples:
595596
*
@@ -621,7 +622,7 @@ public interface AndColumnsSelectionDsl {
621622
*
622623
* You can even mix and match any [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi]!
623624
*
624-
* ### Check out: [Usage][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Usage]
625+
* ### Check out: [Grammar][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.Grammar]
625626
*
626627
* #### Examples:
627628
*

0 commit comments

Comments
 (0)