Skip to content

Commit fe066d2

Browse files
JolanrensenJolanrensen
authored
Merge pull request #1018 from Kotlin/Arg->snake-case
Renaming all KoDEx documentation arguments to SCREAMING_SNAKE_CASE
2 parents 7f46ae2 + dde15e7 commit fe066d2

Some content is hidden

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

60 files changed

+1138
-1261
lines changed

‎core/api/core.api‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -8818,7 +8818,7 @@ public final class org/jetbrains/kotlinx/dataframe/api/Update {
88188818
public abstract interface class org/jetbrains/kotlinx/dataframe/api/Update$Columns {
88198819
}
88208820

8821-
public abstract interface class org/jetbrains/kotlinx/dataframe/api/Update$Columns$SelectingColumnsArg {
8821+
public abstract interface class org/jetbrains/kotlinx/dataframe/api/Update$Columns$SELECTING_COLUMNS {
88228822
}
88238823

88248824
public abstract interface class org/jetbrains/kotlinx/dataframe/api/Update$Grammar {
@@ -9739,6 +9739,18 @@ public abstract interface class org/jetbrains/kotlinx/dataframe/documentation/Ds
97399739
public abstract interface class org/jetbrains/kotlinx/dataframe/documentation/DslGrammarTemplateColumnsSelectionDsl$DslGrammarTemplate {
97409740
}
97419741

9742+
public abstract interface class org/jetbrains/kotlinx/dataframe/documentation/DslGrammarTemplateColumnsSelectionDsl$DslGrammarTemplate$COLUMN_GROUP_FUNCTIONS {
9743+
}
9744+
9745+
public abstract interface class org/jetbrains/kotlinx/dataframe/documentation/DslGrammarTemplateColumnsSelectionDsl$DslGrammarTemplate$COLUMN_GROUP_PART {
9746+
}
9747+
9748+
public abstract interface class org/jetbrains/kotlinx/dataframe/documentation/DslGrammarTemplateColumnsSelectionDsl$DslGrammarTemplate$COLUMN_SET_FUNCTIONS {
9749+
}
9750+
9751+
public abstract interface class org/jetbrains/kotlinx/dataframe/documentation/DslGrammarTemplateColumnsSelectionDsl$DslGrammarTemplate$COLUMN_SET_PART {
9752+
}
9753+
97429754
public abstract interface class org/jetbrains/kotlinx/dataframe/documentation/DslGrammarTemplateColumnsSelectionDsl$DslGrammarTemplate$ColumnDef {
97439755
}
97449756

@@ -9751,18 +9763,12 @@ public abstract interface class org/jetbrains/kotlinx/dataframe/documentation/Ds
97519763
public abstract interface class org/jetbrains/kotlinx/dataframe/documentation/DslGrammarTemplateColumnsSelectionDsl$DslGrammarTemplate$ColumnGroupDef {
97529764
}
97539765

9754-
public abstract interface class org/jetbrains/kotlinx/dataframe/documentation/DslGrammarTemplateColumnsSelectionDsl$DslGrammarTemplate$ColumnGroupFunctionsArg {
9755-
}
9756-
97579766
public abstract interface class org/jetbrains/kotlinx/dataframe/documentation/DslGrammarTemplateColumnsSelectionDsl$DslGrammarTemplate$ColumnGroupNoSingleColumnDef {
97589767
}
97599768

97609769
public abstract interface class org/jetbrains/kotlinx/dataframe/documentation/DslGrammarTemplateColumnsSelectionDsl$DslGrammarTemplate$ColumnGroupNoSingleColumnRef {
97619770
}
97629771

9763-
public abstract interface class org/jetbrains/kotlinx/dataframe/documentation/DslGrammarTemplateColumnsSelectionDsl$DslGrammarTemplate$ColumnGroupPart {
9764-
}
9765-
97669772
public abstract interface class org/jetbrains/kotlinx/dataframe/documentation/DslGrammarTemplateColumnsSelectionDsl$DslGrammarTemplate$ColumnGroupRef {
97679773
}
97689774

@@ -9796,12 +9802,6 @@ public abstract interface class org/jetbrains/kotlinx/dataframe/documentation/Ds
97969802
public abstract interface class org/jetbrains/kotlinx/dataframe/documentation/DslGrammarTemplateColumnsSelectionDsl$DslGrammarTemplate$ColumnSetDef {
97979803
}
97989804

9799-
public abstract interface class org/jetbrains/kotlinx/dataframe/documentation/DslGrammarTemplateColumnsSelectionDsl$DslGrammarTemplate$ColumnSetFunctionsArg {
9800-
}
9801-
9802-
public abstract interface class org/jetbrains/kotlinx/dataframe/documentation/DslGrammarTemplateColumnsSelectionDsl$DslGrammarTemplate$ColumnSetPart {
9803-
}
9804-
98059805
public abstract interface class org/jetbrains/kotlinx/dataframe/documentation/DslGrammarTemplateColumnsSelectionDsl$DslGrammarTemplate$ColumnSetRef {
98069806
}
98079807

@@ -9829,10 +9829,10 @@ public abstract interface class org/jetbrains/kotlinx/dataframe/documentation/Ds
98299829
public abstract interface class org/jetbrains/kotlinx/dataframe/documentation/DslGrammarTemplateColumnsSelectionDsl$DslGrammarTemplate$ConditionRef {
98309830
}
98319831

9832-
public abstract interface class org/jetbrains/kotlinx/dataframe/documentation/DslGrammarTemplateColumnsSelectionDsl$DslGrammarTemplate$DefinitionsArg {
9832+
public abstract interface class org/jetbrains/kotlinx/dataframe/documentation/DslGrammarTemplateColumnsSelectionDsl$DslGrammarTemplate$DEFINITIONS {
98339833
}
98349834

9835-
public abstract interface class org/jetbrains/kotlinx/dataframe/documentation/DslGrammarTemplateColumnsSelectionDsl$DslGrammarTemplate$DefinitionsPart {
9835+
public abstract interface class org/jetbrains/kotlinx/dataframe/documentation/DslGrammarTemplateColumnsSelectionDsl$DslGrammarTemplate$DEFINITIONS_PART {
98369836
}
98379837

98389838
public abstract interface class org/jetbrains/kotlinx/dataframe/documentation/DslGrammarTemplateColumnsSelectionDsl$DslGrammarTemplate$IgnoreCaseDef {
@@ -9877,10 +9877,10 @@ public abstract interface class org/jetbrains/kotlinx/dataframe/documentation/Ds
98779877
public abstract interface class org/jetbrains/kotlinx/dataframe/documentation/DslGrammarTemplateColumnsSelectionDsl$DslGrammarTemplate$NumberRef {
98789878
}
98799879

9880-
public abstract interface class org/jetbrains/kotlinx/dataframe/documentation/DslGrammarTemplateColumnsSelectionDsl$DslGrammarTemplate$PlainDslFunctionsArg {
9880+
public abstract interface class org/jetbrains/kotlinx/dataframe/documentation/DslGrammarTemplateColumnsSelectionDsl$DslGrammarTemplate$PLAIN_DSL_FUNCTIONS {
98819881
}
98829882

9883-
public abstract interface class org/jetbrains/kotlinx/dataframe/documentation/DslGrammarTemplateColumnsSelectionDsl$DslGrammarTemplate$PlainDslPart {
9883+
public abstract interface class org/jetbrains/kotlinx/dataframe/documentation/DslGrammarTemplateColumnsSelectionDsl$DslGrammarTemplate$PLAIN_DSL_PART {
98849884
}
98859885

98869886
public abstract interface class org/jetbrains/kotlinx/dataframe/documentation/DslGrammarTemplateColumnsSelectionDsl$DslGrammarTemplate$RegexDef {

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

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,6 @@ package org.jetbrains.kotlinx.dataframe.api
33
import org.jetbrains.kotlinx.dataframe.ColumnsSelector
44
import org.jetbrains.kotlinx.dataframe.DataFrame
55
import org.jetbrains.kotlinx.dataframe.DataRow
6-
import org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl.DslGrammar.ColumnGroupPartOfGrammar
7-
import org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl.DslGrammar.ColumnSetPartOfGrammar
8-
import org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl.DslGrammar.DefinitionsPartOfGrammar
9-
import org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl.DslGrammar.PlainDslPartOfGrammar
106
import org.jetbrains.kotlinx.dataframe.columns.ColumnPath
117
import org.jetbrains.kotlinx.dataframe.columns.ColumnSet
128
import org.jetbrains.kotlinx.dataframe.columns.ColumnsResolver
@@ -39,7 +35,7 @@ public annotation class ColumnsSelectionDslMarker
3935
/**
4036
* ## Columns Selection DSL
4137
* {@include [SelectingColumns.Dsl.WithExample]}
42-
* {@set [SelectingColumns.OperationArg] [select][DataFrame.select]}
38+
* {@set [SelectingColumns.OPERATION] [select][DataFrame.select]}
4339
*
4440
* @comment This interface be safely cast to [SingleColumn] across the library because it's always
4541
* implemented in combination with [DataFrameReceiver] which is a [SingleColumn] itself.
@@ -114,10 +110,10 @@ public interface ColumnsSelectionDsl<out T> : // SingleColumn<DataRow<T>>
114110
*
115111
* @include [DslGrammarTemplateColumnsSelectionDsl.DslGrammarTemplate]
116112
*
117-
* @set [DslGrammarTemplate.DefinitionsArg] {@include [DefinitionsPartOfGrammar]}
118-
* @set [DslGrammarTemplate.PlainDslFunctionsArg] {@include [PlainDslPartOfGrammar]}
119-
* @set [DslGrammarTemplate.ColumnSetFunctionsArg] {@include [ColumnSetPartOfGrammar]}
120-
* @set [DslGrammarTemplate.ColumnGroupFunctionsArg] {@include [ColumnGroupPartOfGrammar]}
113+
* @set [DslGrammarTemplate.DEFINITIONS] {@include [DefinitionsPartOfGrammar]}
114+
* @set [DslGrammarTemplate.PLAIN_DSL_FUNCTIONS] {@include [PlainDslPartOfGrammar]}
115+
* @set [DslGrammarTemplate.COLUMN_SET_FUNCTIONS] {@include [ColumnSetPartOfGrammar]}
116+
* @set [DslGrammarTemplate.COLUMN_GROUP_FUNCTIONS] {@include [ColumnGroupPartOfGrammar]}
121117
*/
122118
public interface DslGrammar {
123119

@@ -385,7 +381,7 @@ public interface ColumnsSelectionDsl<out T> : // SingleColumn<DataRow<T>>
385381

386382
/**
387383
* @include [SelectColumnsSelectionDsl.CommonSelectDocs]
388-
* @set [SelectColumnsSelectionDsl.CommonSelectDocs.ExampleArg]
384+
* @set [SelectColumnsSelectionDsl.CommonSelectDocs.EXAMPLE]
389385
*
390386
* `df.`[select][DataFrame.select]` { myColGroup.`[`select`][SingleColumn.select]` { someCol `[`and`][ColumnsSelectionDsl.and]` `[`colsOf`][SingleColumn.colsOf]`<`[`String`][String]`>() } }`
391387
*
@@ -396,7 +392,7 @@ public interface ColumnsSelectionDsl<out T> : // SingleColumn<DataRow<T>>
396392

397393
/**
398394
* @include [SelectColumnsSelectionDsl.CommonSelectDocs]
399-
* @set [SelectColumnsSelectionDsl.CommonSelectDocs.ExampleArg]
395+
* @set [SelectColumnsSelectionDsl.CommonSelectDocs.EXAMPLE]
400396
*
401397
* `df.`[select][DataFrame.select]` { Type::myColGroup.`[`select`][KProperty.select]` { someCol `[`and`][ColumnsSelectionDsl.and]` `[`colsOf`][SingleColumn.colsOf]`<`[`String`][String]`>() } }`
402398
*
@@ -407,7 +403,7 @@ public interface ColumnsSelectionDsl<out T> : // SingleColumn<DataRow<T>>
407403

408404
/**
409405
* @include [SelectColumnsSelectionDsl.CommonSelectDocs]
410-
* @set [SelectColumnsSelectionDsl.CommonSelectDocs.ExampleArg]
406+
* @set [SelectColumnsSelectionDsl.CommonSelectDocs.EXAMPLE]
411407
*
412408
* `df.`[select][DataFrame.select]` { "myColGroup".`[`select`][String.select]` { someCol `[`and`][ColumnsSelectionDsl.and]` `[`colsOf`][SingleColumn.colsOf]`<`[`String`][String]`>() } }`
413409
*
@@ -417,7 +413,7 @@ public interface ColumnsSelectionDsl<out T> : // SingleColumn<DataRow<T>>
417413

418414
/**
419415
* @include [SelectColumnsSelectionDsl.CommonSelectDocs]
420-
* @set [SelectColumnsSelectionDsl.CommonSelectDocs.ExampleArg]
416+
* @set [SelectColumnsSelectionDsl.CommonSelectDocs.EXAMPLE]
421417
*
422418
* `df.`[select][DataFrame.select]` { "pathTo"["myColGroup"].`[`select`][ColumnPath.select]` { someCol `[`and`][ColumnsSelectionDsl.and]` `[`colsOf`][SingleColumn.colsOf]`<`[`String`][String]`>() } }`
423419
*

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

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,7 @@ import org.jetbrains.kotlinx.dataframe.DataFrame
1010
import org.jetbrains.kotlinx.dataframe.annotations.AccessApiOverload
1111
import org.jetbrains.kotlinx.dataframe.annotations.Interpretable
1212
import org.jetbrains.kotlinx.dataframe.annotations.Refine
13-
import org.jetbrains.kotlinx.dataframe.api.DropNA.DropNASelectingOptions
14-
import org.jetbrains.kotlinx.dataframe.api.DropNaNs.DropNaNsSelectingOptions
15-
import org.jetbrains.kotlinx.dataframe.api.DropNulls.DropNullsSelectingOptions
16-
import org.jetbrains.kotlinx.dataframe.api.Update.UpdateOperationArg
13+
import org.jetbrains.kotlinx.dataframe.api.Update.UPDATE_OPERATION
1714
import org.jetbrains.kotlinx.dataframe.columns.ColumnKind
1815
import org.jetbrains.kotlinx.dataframe.columns.ColumnReference
1916
import org.jetbrains.kotlinx.dataframe.columns.toColumnSet
@@ -41,7 +38,7 @@ import kotlin.reflect.KProperty
4138
*/
4239
internal interface FillNulls {
4340

44-
/** @include [Update.Grammar] {@set [UpdateOperationArg] [**fillNulls**][fillNulls]} */
41+
/** @include [Update.Grammar] {@set [UPDATE_OPERATION] [**fillNulls**][fillNulls]} */
4542
interface Grammar
4643

4744
/**
@@ -51,14 +48,14 @@ internal interface FillNulls {
5148
interface FillNullsSelectingOptions
5249
}
5350

54-
/** {@set [SelectingColumns.OperationArg] [fillNulls][fillNulls]} */
51+
/** {@set [SelectingColumns.OPERATION] [fillNulls][fillNulls]} */
5552
private interface SetFillNullsOperationArg
5653

5754
/**
5855
* @include [FillNulls] {@comment Description of the fillNulls operation.}
5956
* @include [LineBreak]
6057
* @include [Update.Columns] {@comment Description of what this function expects the user to do: select columns}
61-
* {@set [Update.Columns.SelectingColumnsArg] [Selecting Columns][FillNulls.FillNullsSelectingOptions]}
58+
* {@set [Update.Columns.SELECTING_COLUMNS] [Selecting Columns][FillNulls.FillNullsSelectingOptions]}
6259
* ### This Fill Nulls Overload
6360
*
6461
*/
@@ -135,7 +132,7 @@ internal inline val Float?.isNA: Boolean get() = this == null || this.isNaN()
135132
*/
136133
internal interface FillNaNs {
137134

138-
/** @include [Update.Grammar] {@set [Update.UpdateOperationArg] [fillNaNs][fillNaNs]} */
135+
/** @include [Update.Grammar] {@set [Update.UPDATE_OPERATION] [fillNaNs][fillNaNs]} */
139136
interface Grammar
140137

141138
/**
@@ -145,15 +142,15 @@ internal interface FillNaNs {
145142
interface FillNaNsSelectingOptions
146143
}
147144

148-
/** {@set [SelectingColumns.OperationArg] [fillNaNs][fillNaNs]} */
145+
/** {@set [SelectingColumns.OPERATION] [fillNaNs][fillNaNs]} */
149146
@ExcludeFromSources
150147
internal interface SetFillNaNsOperationArg
151148

152149
/**
153150
* @include [FillNaNs] {@comment Description of the fillNaNs operation.}
154151
* @include [LineBreak]
155152
* @include [Update.Columns] {@comment Description of what this function expects the user to do: select columns}
156-
* {@set [Update.Columns.SelectingColumnsArg] [Selecting Columns][FillNaNs.FillNaNsSelectingOptions]}
153+
* {@set [Update.Columns.SELECTING_COLUMNS] [Selecting Columns][FillNaNs.FillNaNsSelectingOptions]}
157154
* ### This Fill NaNs Overload
158155
*/
159156
@ExcludeFromSources
@@ -207,7 +204,7 @@ public fun <T, C> DataFrame<T>.fillNaNs(vararg columns: ColumnReference<C>): Upd
207204
*/
208205
internal interface FillNA {
209206

210-
/** @include [Update.Grammar] {@set [Update.UpdateOperationArg] [fillNA][fillNA]} */
207+
/** @include [Update.Grammar] {@set [Update.UPDATE_OPERATION] [fillNA][fillNA]} */
211208
interface Grammar
212209

213210
/**
@@ -217,15 +214,15 @@ internal interface FillNA {
217214
interface FillNASelectingOptions
218215
}
219216

220-
/** {@set [SelectingColumns.OperationArg] [fillNA][fillNA]} */
217+
/** {@set [SelectingColumns.OPERATION] [fillNA][fillNA]} */
221218
@ExcludeFromSources
222219
internal interface SetFillNAOperationArg
223220

224221
/**
225222
* @include [FillNA] {@comment Description of the fillNA operation.}
226223
* @include [LineBreak]
227224
* @include [Update.Columns] {@comment Description of what this function expects the user to do: select columns}
228-
* {@set [Update.Columns.SelectingColumnsArg] [Selecting Columns][FillNA.FillNASelectingOptions]}
225+
* {@set [Update.Columns.SELECTING_COLUMNS] [Selecting Columns][FillNA.FillNASelectingOptions]}
229226
* ### This Fill NA Overload
230227
*/
231228
@ExcludeFromSources
@@ -312,7 +309,7 @@ internal interface DropNulls {
312309
interface DropNullsSelectingOptions
313310
}
314311

315-
/** {@set [SelectingColumns.OperationArg] [dropNulls][dropNulls]} */
312+
/** {@set [SelectingColumns.OPERATION] [dropNulls][dropNulls]} */
316313
@ExcludeFromSources
317314
private interface SetDropNullsOperationArg
318315

@@ -420,7 +417,7 @@ internal interface DropNA {
420417
interface DropNASelectingOptions
421418
}
422419

423-
/** {@set [SelectingColumns.OperationArg] [dropNA][dropNA]} */
420+
/** {@set [SelectingColumns.OPERATION] [dropNA][dropNA]} */
424421
@ExcludeFromSources
425422
private interface SetDropNAOperationArg
426423

@@ -529,7 +526,7 @@ internal interface DropNaNs {
529526
interface DropNaNsSelectingOptions
530527
}
531528

532-
/** {@set [SelectingColumns.OperationArg] [dropNaNs][dropNaNs]} */
529+
/** {@set [SelectingColumns.OPERATION] [dropNaNs][dropNaNs]} */
533530
@ExcludeFromSources
534531
private interface SetDropNaNsOperationArg
535532

0 commit comments

Comments
 (0)