Skip to content

Commit 1e88880

Browse files
JolanrensenJolanrensen
committed
doc processor 0.3.0: renaming getArg and setArg to get and set
1 parent 8456d68 commit 1e88880

Some content is hidden

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

44 files changed

+1165
-1142
lines changed

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

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ public annotation class ColumnsSelectionDslMarker
3838
/**
3939
* ## Columns Selection DSL
4040
* {@include [SelectingColumns.Dsl.WithExample]}
41-
* {@setArg [SelectingColumns.OperationArg] [select][DataFrame.select]}
41+
* {@set [SelectingColumns.OperationArg] [select][DataFrame.select]}
4242
*
4343
* @comment This interface be safely cast to [SingleColumn] across the library because it's always
4444
* implemented in combination with [DataFrameReceiver] which is a [SingleColumn] itself.
@@ -121,7 +121,7 @@ public interface ColumnsSelectionDsl<out T> : /* SingleColumn<DataRow<T>> */
121121
*
122122
* @include [DslGrammarTemplateColumnsSelectionDsl.DslGrammarTemplate]
123123
*
124-
* {@setArg [DslGrammarTemplate.DefinitionsArg]
124+
* {@set [DslGrammarTemplate.DefinitionsArg]
125125
* {@include [DslGrammarTemplate.ColumnGroupNoSingleColumnDef]}
126126
*
127127
* {@include [DslGrammarTemplate.ColumnSelectorDef]}
@@ -169,7 +169,7 @@ public interface ColumnsSelectionDsl<out T> : /* SingleColumn<DataRow<T>> */
169169
* {@include [DslGrammarTemplate.TextDef]}
170170
* }
171171
* {@comment Plain DSL: -------------------------------------------------------------------------------------------- }
172-
* {@setArg [DslGrammarTemplate.PlainDslFunctionsArg]
172+
* {@set [DslGrammarTemplate.PlainDslFunctionsArg]
173173
*
174174
* {@include [DslGrammarTemplate.ColumnRef]} {@include [ColumnRangeColumnsSelectionDsl.Grammar.PlainDslName]} {@include [DslGrammarTemplate.ColumnRef]}
175175
*
@@ -242,7 +242,7 @@ public interface ColumnsSelectionDsl<out T> : /* SingleColumn<DataRow<T>> */
242242
* `|` {@include [WithoutNullsColumnsSelectionDsl.Grammar.PlainDslName]}**`()`**
243243
* }
244244
* {@comment ColumnSet: -------------------------------------------------------------------------------------------- }
245-
* {@setArg [DslGrammarTemplate.ColumnSetFunctionsArg]
245+
* {@set [DslGrammarTemplate.ColumnSetFunctionsArg]
246246
*
247247
* {@include [Indent]}[**`[`**][ColumnsSelectionDsl.col]{@include [DslGrammarTemplate.IndexRef]}[**`]`**][ColumnsSelectionDsl.col]
248248
*
@@ -313,7 +313,7 @@ public interface ColumnsSelectionDsl<out T> : /* SingleColumn<DataRow<T>> */
313313
* {@include [Indent]}`|` {@include [WithoutNullsColumnsSelectionDsl.Grammar.ColumnSetName]}**`()`**
314314
* }
315315
* {@comment ColumnGroup: -------------------------------------------------------------------------------------------- }
316-
* {@setArg [DslGrammarTemplate.ColumnGroupFunctionsArg]
316+
* {@set [DslGrammarTemplate.ColumnGroupFunctionsArg]
317317
*
318318
* {@include [Indent]}`|` [**`[`**][cols]{@include [DslGrammarTemplate.ColumnRef]}**`,`**` ..`[**`]`**][cols]
319319
*
@@ -421,7 +421,7 @@ public interface ColumnsSelectionDsl<out T> : /* SingleColumn<DataRow<T>> */
421421

422422
/**
423423
* @include [SelectColumnsSelectionDsl.CommonSelectDocs]
424-
* @setArg [SelectColumnsSelectionDsl.CommonSelectDocs.ExampleArg]
424+
* @set [SelectColumnsSelectionDsl.CommonSelectDocs.ExampleArg]
425425
*
426426
* `df.`[select][DataFrame.select]` { myColGroup.`[select][SingleColumn.select]` { someCol `[and][ColumnsSelectionDsl.and]` `[colsOf][SingleColumn.colsOf]`<`[String][String]`>() } }`
427427
*
@@ -432,7 +432,7 @@ public interface ColumnsSelectionDsl<out T> : /* SingleColumn<DataRow<T>> */
432432

433433
/**
434434
* @include [SelectColumnsSelectionDsl.CommonSelectDocs]
435-
* @setArg [SelectColumnsSelectionDsl.CommonSelectDocs.ExampleArg]
435+
* @set [SelectColumnsSelectionDsl.CommonSelectDocs.ExampleArg]
436436
*
437437
* `df.`[select][DataFrame.select]` { Type::myColGroup.`[select][KProperty.select]` { someCol `[and][ColumnsSelectionDsl.and]` `[colsOf][SingleColumn.colsOf]`<`[String][String]`>() } }`
438438
*
@@ -450,7 +450,7 @@ public interface ColumnsSelectionDsl<out T> : /* SingleColumn<DataRow<T>> */
450450

451451
/**
452452
* @include [SelectColumnsSelectionDsl.CommonSelectDocs]
453-
* @setArg [SelectColumnsSelectionDsl.CommonSelectDocs.ExampleArg]
453+
* @set [SelectColumnsSelectionDsl.CommonSelectDocs.ExampleArg]
454454
*
455455
* `df.`[select][DataFrame.select]` { Type::myColGroup.`[select][KProperty.select]` { someCol `[and][ColumnsSelectionDsl.and]` `[colsOf][SingleColumn.colsOf]`<`[String][String]`>() } }`
456456
*
@@ -463,7 +463,7 @@ public interface ColumnsSelectionDsl<out T> : /* SingleColumn<DataRow<T>> */
463463

464464
/**
465465
* @include [SelectColumnsSelectionDsl.CommonSelectDocs]
466-
* @setArg [SelectColumnsSelectionDsl.CommonSelectDocs.ExampleArg]
466+
* @set [SelectColumnsSelectionDsl.CommonSelectDocs.ExampleArg]
467467
*
468468
* `df.`[select][DataFrame.select]` { "myColGroup".`[select][String.select]` { someCol `[and][ColumnsSelectionDsl.and]` `[colsOf][SingleColumn.colsOf]`<`[String][String]`>() } }`
469469
*
@@ -474,7 +474,7 @@ public interface ColumnsSelectionDsl<out T> : /* SingleColumn<DataRow<T>> */
474474

475475
/**
476476
* @include [SelectColumnsSelectionDsl.CommonSelectDocs]
477-
* @setArg [SelectColumnsSelectionDsl.CommonSelectDocs.ExampleArg]
477+
* @set [SelectColumnsSelectionDsl.CommonSelectDocs.ExampleArg]
478478
*
479479
* `df.`[select][DataFrame.select]` { "pathTo"["myColGroup"].`[select][ColumnPath.select]` { someCol `[and][ColumnsSelectionDsl.and]` `[colsOf][SingleColumn.colsOf]`<`[String][String]`>() } }`
480480
*

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

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ import kotlin.reflect.KProperty
2222
*/
2323
internal interface FillNulls {
2424

25-
/** @include [Update.Grammar] {@setArg [UpdateOperationArg] [**fillNulls**][fillNulls]} */
25+
/** @include [Update.Grammar] {@set [UpdateOperationArg] [**fillNulls**][fillNulls]} */
2626
interface Grammar
2727

2828
/**
@@ -32,14 +32,14 @@ internal interface FillNulls {
3232
interface FillNullsSelectingOptions
3333
}
3434

35-
/** {@setArg [SelectingColumns.OperationArg] [fillNulls][fillNulls]} */
35+
/** {@set [SelectingColumns.OperationArg] [fillNulls][fillNulls]} */
3636
private interface SetFillNullsOperationArg
3737

3838
/**
3939
* @include [FillNulls] {@comment Description of the fillNulls operation.}
4040
* @include [LineBreak]
4141
* @include [Update.Columns] {@comment Description of what this function expects the user to do: select columns}
42-
* {@setArg [Update.Columns.SelectingColumnsArg] [Selecting Columns][FillNulls.FillNullsSelectingOptions]}
42+
* {@set [Update.Columns.SelectingColumnsArg] [Selecting Columns][FillNulls.FillNullsSelectingOptions]}
4343
* ### This Fill Nulls Overload
4444
*
4545
*/
@@ -113,7 +113,7 @@ internal inline val Float?.isNA: Boolean get() = this == null || this.isNaN()
113113
*/
114114
internal interface FillNaNs {
115115

116-
/** @include [Update.Grammar] {@setArg [Update.UpdateOperationArg] [fillNaNs][fillNaNs]} */
116+
/** @include [Update.Grammar] {@set [Update.UpdateOperationArg] [fillNaNs][fillNaNs]} */
117117
interface Grammar
118118

119119
/**
@@ -123,14 +123,14 @@ internal interface FillNaNs {
123123
interface FillNaNsSelectingOptions
124124
}
125125

126-
/** {@setArg [SelectingColumns.OperationArg] [fillNaNs][fillNaNs]} */
126+
/** {@set [SelectingColumns.OperationArg] [fillNaNs][fillNaNs]} */
127127
internal interface SetFillNaNsOperationArg
128128

129129
/**
130130
* @include [FillNaNs] {@comment Description of the fillNaNs operation.}
131131
* @include [LineBreak]
132132
* @include [Update.Columns] {@comment Description of what this function expects the user to do: select columns}
133-
* {@setArg [Update.Columns.SelectingColumnsArg] [Selecting Columns][FillNaNs.FillNaNsSelectingOptions]}
133+
* {@set [Update.Columns.SelectingColumnsArg] [Selecting Columns][FillNaNs.FillNaNsSelectingOptions]}
134134
* ### This Fill NaNs Overload
135135
*/
136136
private interface CommonFillNaNsFunctionDoc
@@ -183,7 +183,7 @@ public fun <T, C> DataFrame<T>.fillNaNs(vararg columns: ColumnReference<C>): Upd
183183
*/
184184
internal interface FillNA {
185185

186-
/** @include [Update.Grammar] {@setArg [Update.UpdateOperationArg] [fillNA][fillNA]} */
186+
/** @include [Update.Grammar] {@set [Update.UpdateOperationArg] [fillNA][fillNA]} */
187187
interface Grammar
188188

189189
/**
@@ -193,14 +193,14 @@ internal interface FillNA {
193193
interface FillNASelectingOptions
194194
}
195195

196-
/** {@setArg [SelectingColumns.OperationArg] [fillNA][fillNA]} */
196+
/** {@set [SelectingColumns.OperationArg] [fillNA][fillNA]} */
197197
internal interface SetFillNAOperationArg
198198

199199
/**
200200
* @include [FillNA] {@comment Description of the fillNA operation.}
201201
* @include [LineBreak]
202202
* @include [Update.Columns] {@comment Description of what this function expects the user to do: select columns}
203-
* {@setArg [Update.Columns.SelectingColumnsArg] [Selecting Columns][FillNA.FillNASelectingOptions]}
203+
* {@set [Update.Columns.SelectingColumnsArg] [Selecting Columns][FillNA.FillNASelectingOptions]}
204204
* ### This Fill NA Overload
205205
*/
206206
private interface CommonFillNAFunctionDoc
@@ -281,7 +281,7 @@ internal interface DropNulls {
281281
interface DropNullsSelectingOptions
282282
}
283283

284-
/** {@setArg [SelectingColumns.OperationArg] [dropNulls][dropNulls]} */
284+
/** {@set [SelectingColumns.OperationArg] [dropNulls][dropNulls]} */
285285
private interface SetDropNullsOperationArg
286286

287287
/**
@@ -380,7 +380,7 @@ internal interface DropNA {
380380
interface DropNASelectingOptions
381381
}
382382

383-
/** {@setArg [SelectingColumns.OperationArg] [dropNA][dropNA]} */
383+
/** {@set [SelectingColumns.OperationArg] [dropNA][dropNA]} */
384384
private interface SetDropNAOperationArg
385385

386386
/**
@@ -482,7 +482,7 @@ internal interface DropNaNs {
482482
interface DropNaNsSelectingOptions
483483
}
484484

485-
/** {@setArg [SelectingColumns.OperationArg] [dropNaNs][dropNaNs]} */
485+
/** {@set [SelectingColumns.OperationArg] [dropNaNs][dropNaNs]} */
486486
private interface SetDropNaNsOperationArg
487487

488488
/**

0 commit comments

Comments
 (0)