Skip to content

Commit 18c5db4

Browse files
committed
fixed documentation urls
1 parent 4180389 commit 18c5db4

File tree

9 files changed

+85
-95
lines changed

9 files changed

+85
-95
lines changed

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ public annotation class ColumnsSelectionDslMarker
3939
* Select or express columns using the [Columns Selection DSL][org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl].
4040
* (Any (combination of) [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi]).
4141
*
42-
* This DSL comes in the form a [Columns Selector][org.jetbrains.kotlinx.dataframe.ColumnsSelector] lambda,
42+
* This DSL is initiated by a [Columns Selector][org.jetbrains.kotlinx.dataframe.ColumnsSelector] lambda,
4343
* which operates on the [Columns Selection DSL][org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl] and
4444
* expects you to return a [ColumnsResolver][org.jetbrains.kotlinx.dataframe.columns.ColumnsResolver]; an entity formed by calling any (combination) of the functions
4545
* in the DSL that is or can be resolved into one or more columns.
@@ -51,11 +51,11 @@ public annotation class ColumnsSelectionDslMarker
5151
*
5252
* #### For example:
5353
*
54-
* `df.`select` { length `[and][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.and]` age }`
54+
* `df.`[select][DataFrame.select]` { length `[and][org.jetbrains.kotlinx.dataframe.api.AndColumnsSelectionDsl.and]` age }`
5555
*
56-
* `df.`select` { `[cols][org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl.cols]`(1..5) }`
56+
* `df.`[select][DataFrame.select]` { `[cols][org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl.cols]`(1..5) }`
5757
*
58-
* `df.`select` { `[colsOf][org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl.colsOf]`<`[Double][Double]`>() }`
58+
* `df.`[select][DataFrame.select]` { `[colsOf][org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl.colsOf]`<`[Double][Double]`>() }`
5959
*
6060
*
6161
*

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

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

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ private interface UpdateWithNote
145145
*
146146
* ### Check out: [Usage][org.jetbrains.kotlinx.dataframe.api.Update.Usage]
147147
*
148-
* For more information: [See Column Selectors on the documentation website.](https://kotlin.github.io/dataframe/update.html)
148+
* For more information: [See `update` on the documentation website.](https://kotlin.github.io/dataframe/update.html)
149149
*
150150
* &nbsp;&nbsp;&nbsp;&nbsp;
151151
*
@@ -154,7 +154,7 @@ private interface UpdateWithNote
154154
* Select or express columns using the [Columns Selection DSL][org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl].
155155
* (Any (combination of) [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi]).
156156
*
157-
* This DSL comes in the form a [Columns Selector][org.jetbrains.kotlinx.dataframe.ColumnsSelector] lambda,
157+
* This DSL is initiated by a [Columns Selector][org.jetbrains.kotlinx.dataframe.ColumnsSelector] lambda,
158158
* which operates on the [Columns Selection DSL][org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl] and
159159
* expects you to return a [ColumnsResolver][org.jetbrains.kotlinx.dataframe.columns.ColumnsResolver]; an entity formed by calling any (combination) of the functions
160160
* in the DSL that is or can be resolved into one or more columns.

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

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

33
internal interface DocumentationUrls {
44

5-
interface NameArg
6-
7-
/** See {@getArg [NameArg]} on the documentation website. */
8-
interface Text
9-
105
/** https://kotlin.github.io/dataframe */
116
interface Url
127

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ internal interface SelectingColumnsLink
3838
* Select or express columns using the [Columns Selection DSL][org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl].
3939
* (Any (combination of) [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi]).
4040
*
41-
* This DSL comes in the form a [Columns Selector][org.jetbrains.kotlinx.dataframe.ColumnsSelector] lambda,
41+
* This DSL is initiated by a [Columns Selector][org.jetbrains.kotlinx.dataframe.ColumnsSelector] lambda,
4242
* which operates on the [Columns Selection DSL][org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl] and
4343
* expects you to return a [ColumnsResolver][org.jetbrains.kotlinx.dataframe.columns.ColumnsResolver]; an entity formed by calling any (combination) of the functions
4444
* in the DSL that is or can be resolved into one or more columns.
@@ -103,7 +103,7 @@ internal interface SelectingColumns {
103103
* Select or express columns using the [Columns Selection DSL][org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl].
104104
* (Any (combination of) [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi]).
105105
*
106-
* This DSL comes in the form a [Columns Selector][ColumnsSelector] lambda,
106+
* This DSL is initiated by a [Columns Selector][ColumnsSelector] lambda,
107107
* which operates on the [Columns Selection DSL][org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl] and
108108
* expects you to return a [ColumnsResolver]; an entity formed by calling any (combination) of the functions
109109
* in the DSL that is or can be resolved into one or more columns.
@@ -119,7 +119,7 @@ internal interface SelectingColumns {
119119
* Select or express columns using the [Columns Selection DSL][org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl].
120120
* (Any (combination of) [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi]).
121121
*
122-
* This DSL comes in the form a [Columns Selector][org.jetbrains.kotlinx.dataframe.ColumnsSelector] lambda,
122+
* This DSL is initiated by a [Columns Selector][org.jetbrains.kotlinx.dataframe.ColumnsSelector] lambda,
123123
* which operates on the [Columns Selection DSL][org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl] and
124124
* expects you to return a [ColumnsResolver][org.jetbrains.kotlinx.dataframe.columns.ColumnsResolver]; an entity formed by calling any (combination) of the functions
125125
* in the DSL that is or can be resolved into one or more columns.
@@ -149,7 +149,7 @@ internal interface SelectingColumns {
149149
* Select or express a single column using the Column Selection DSL.
150150
* (Any [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi]).
151151
*
152-
* This DSL comes in the form of a [Column Selector][ColumnSelector] lambda,
152+
* This DSL is initiated by a [Column Selector][ColumnSelector] lambda,
153153
* which operates in the [Column Selection DSL][org.jetbrains.kotlinx.dataframe.api.ColumnSelectionDsl] and
154154
* expects you to return a [SingleColumn].
155155
*
@@ -164,7 +164,7 @@ internal interface SelectingColumns {
164164
* Select or express a single column using the Column Selection DSL.
165165
* (Any [Access API][org.jetbrains.kotlinx.dataframe.documentation.AccessApi]).
166166
*
167-
* This DSL comes in the form of a [Column Selector][org.jetbrains.kotlinx.dataframe.ColumnSelector] lambda,
167+
* This DSL is initiated by a [Column Selector][org.jetbrains.kotlinx.dataframe.ColumnSelector] lambda,
168168
* which operates in the [Column Selection DSL][org.jetbrains.kotlinx.dataframe.api.ColumnSelectionDsl] and
169169
* expects you to return a [SingleColumn][org.jetbrains.kotlinx.dataframe.columns.SingleColumn].
170170
*

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ public annotation class ColumnsSelectionDslMarker
3737
/**
3838
* ## Columns Selection DSL
3939
* {@include [SelectingColumns.Dsl.WithExample]}
40-
* {@setArg [SelectingColumns.OperationArg] select}
40+
* {@setArg [SelectingColumns.OperationArg] [select][DataFrame.select]}
4141
*
4242
* @comment This interface be safely cast to [SingleColumn] across the library. It does not directly
4343
* implement it for DSL purposes.

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ private interface SetFillNullsOperationArg
3434
* @include [LineBreak]
3535
* @include [Update.Columns] {@comment Description of what this function expects the user to do: select columns}
3636
*
37-
* ## This Fill Nulls Overload
37+
* ### This Fill Nulls Overload
3838
*
3939
*/
4040
private interface CommonFillNullsFunctionDoc
@@ -118,7 +118,7 @@ internal interface SetFillNaNsOperationArg
118118
* @include [FillNaNs] {@comment Description of the fillNaNs operation.}
119119
* @include [LineBreak]
120120
* @include [Update.Columns] {@comment Description of what this function expects the user to do: select columns}
121-
* ## This Fill NaNs Overload
121+
* ### This Fill NaNs Overload
122122
*/
123123
private interface CommonFillNaNsFunctionDoc
124124

@@ -181,7 +181,7 @@ internal interface SetFillNAOperationArg
181181
* @include [FillNA] {@comment Description of the fillNA operation.}
182182
* @include [LineBreak]
183183
* @include [Update.Columns] {@comment Description of what this function expects the user to do: select columns}
184-
* ## This Fill NA Overload
184+
* ### This Fill NA Overload
185185
*/
186186
private interface CommonFillNAFunctionDoc
187187

@@ -259,7 +259,7 @@ private interface SetDropNullsOperationArg
259259

260260
/**
261261
* @include [DropNulls] {@comment Description of the dropNulls operation.}
262-
* ## This Drop Nulls Overload
262+
* ### This Drop Nulls Overload
263263
*/
264264
private interface CommonDropNullsFunctionDoc
265265

@@ -352,7 +352,7 @@ private interface SetDropNAOperationArg
352352

353353
/**
354354
* @include [DropNA] {@comment Description of the dropNA operation.}
355-
* ## This Drop NA Overload
355+
* ### This Drop NA Overload
356356
*/
357357
private interface CommonDropNAFunctionDoc
358358

@@ -448,7 +448,7 @@ private interface SetDropNaNsOperationArg
448448

449449
/**
450450
* @include [DropNaNs] {@comment Description of the dropNaNs operation.}
451-
* ## This Drop NaNs Overload
451+
* ### This Drop NaNs Overload
452452
*/
453453
private interface CommonDropNaNsFunctionDoc
454454

core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/documentation/DocumentationUrls.kt

Lines changed: 20 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -2,78 +2,73 @@ package org.jetbrains.kotlinx.dataframe.documentation
22

33
internal interface DocumentationUrls {
44

5-
interface NameArg
6-
7-
/** See {@getArg [NameArg]} on the documentation website. */
8-
interface Text
9-
105
/** https://kotlin.github.io/dataframe */
116
interface Url
127

138
interface DataRow {
149

15-
/** [{@include [Text]}{@setArg [NameArg] Row Expressions}]({@include [Url]}/datarow.html#row-expressions) */
10+
/** [See Row Expressions on the documentation website.]({@include [Url]}/datarow.html#row-expressions) */
1611
interface RowExpressions
1712

18-
/** [{@include [Text]}{@setArg [NameArg] Row Conditions}]({@include [Url]}/datarow.html#row-conditions) */
13+
/** [See Row Conditions on the documentation website.]({@include [Url]}/datarow.html#row-conditions) */
1914
interface RowConditions
2015
}
2116

22-
/** [{@include [Text]}{@setArg [NameArg] `NaN` and `NA`}]({@include [Url]}/nanAndNa.html) */
17+
/** [See `NaN` and `NA` on the documentation website.]({@include [Url]}/nanAndNa.html) */
2318
interface NanAndNa {
2419

25-
/** [{@include [Text]}{@setArg [NameArg] `NaN`}]({@include [Url]}/nanAndNa.html#nan) */
20+
/** [See `NaN` on the documentation website.]({@include [Url]}/nanAndNa.html#nan) */
2621
interface NaN
2722

28-
/** [{@include [Text]}{@setArg [NameArg] `NA`}]({@include [Url]}/nanAndNa.html#na) */
23+
/** [See `NA` on the documentation website.]({@include [Url]}/nanAndNa.html#na) */
2924
interface NA
3025
}
3126

32-
/** [{@include [Text]}{@setArg [NameArg] `update`}]({@include [Url]}/update.html) */
27+
/** [See `update` on the documentation website.]({@include [Url]}/update.html) */
3328
interface Update
3429

35-
/** [{@include [Text]}{@setArg [NameArg] `fill`}]({@include [Url]}/fill.html) */
30+
/** [See `fill` on the documentation website.]({@include [Url]}/fill.html) */
3631
interface Fill {
3732

38-
/** [{@include [Text]}{@setArg [NameArg] `fillNulls`}]({@include [Url]}/fill.html#fillnulls) */
33+
/** [See `fillNulls` on the documentation website.]({@include [Url]}/fill.html#fillnulls) */
3934
interface FillNulls
4035

41-
/** [{@include [Text]}{@setArg [NameArg] `fillNaNs`}]({@include [Url]}/fill.html#fillnans) */
36+
/** [See `fillNaNs` on the documentation website.]({@include [Url]}/fill.html#fillnans) */
4237
interface FillNaNs
4338

44-
/** [{@include [Text]}{@setArg [NameArg] `fillNA`}]({@include [Url]}/fill.html#fillna) */
39+
/** [See `fillNA` on the documentation website.]({@include [Url]}/fill.html#fillna) */
4540
interface FillNA
4641
}
4742

48-
/** [{@include [Text]}{@setArg [NameArg] `drop`}]({@include [Url]}/drop.html) */
43+
/** [See `drop` on the documentation website.]({@include [Url]}/drop.html) */
4944
interface Drop {
5045

51-
/** [{@include [Text]}{@setArg [NameArg] `dropNulls`}]({@include [Url]}/drop.html#dropnulls) */
46+
/** [See `dropNulls` on the documentation website.]({@include [Url]}/drop.html#dropnulls) */
5247
interface DropNulls
5348

54-
/** [{@include [Text]}{@setArg [NameArg] `dropNaNs`}]({@include [Url]}/drop.html#dropnans) */
49+
/** [See `dropNaNs` on the documentation website.]({@include [Url]}/drop.html#dropnans) */
5550
interface DropNaNs
5651

57-
/** [{@include [Text]}{@setArg [NameArg] `dropNA`}]({@include [Url]}/drop.html#dropna) */
52+
/** [See `dropNA` on the documentation website.]({@include [Url]}/drop.html#dropna) */
5853
interface DropNA
5954
}
6055

61-
/** [{@include [Text]}{@setArg [NameArg] Access APIs}]({@include [Url]}/apilevels.html) */
56+
/** [See Access APIs on the documentation website.]({@include [Url]}/apilevels.html) */
6257
interface AccessApis {
6358

64-
/** [{@include [Text]}{@setArg [NameArg] String API}]({@include [Url]}/stringapi.html) */
59+
/** [See String API on the documentation website.]({@include [Url]}/stringapi.html) */
6560
interface StringApi
6661

67-
/** [{@include [Text]}{@setArg [NameArg] Column Accessors API}]({@include [Url]}/columnaccessorsapi.html) */
62+
/** [See Column Accessors API on the documentation website.]({@include [Url]}/columnaccessorsapi.html) */
6863
interface ColumnAccessorsApi
6964

70-
/** [{@include [Text]}{@setArg [NameArg] KProperties API}]({@include [Url]}/kpropertiesapi.html) */
65+
/** [See KProperties API on the documentation website.]({@include [Url]}/kpropertiesapi.html) */
7166
interface KPropertiesApi
7267

73-
/** [{@include [Text]}{@setArg [NameArg] Extension Properties API}]({@include [Url]}/extensionpropertiesapi.html) */
68+
/** [See Extension Properties API on the documentation website.]({@include [Url]}/extensionpropertiesapi.html) */
7469
interface ExtensionPropertiesApi
7570
}
7671

77-
/** [{@include [Text]}{@setArg [NameArg] Column Selectors}]({@include [Url]}/columnselectors.html) */
72+
/** [See Column Selectors on the documentation website.]({@include [Url]}/columnselectors.html) */
7873
interface ColumnSelectors
7974
}

core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/documentation/SelectingColumns.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ internal interface SelectingColumns {
5959
* Select or express columns using the {@include [ColumnsSelectionDslLink]}.
6060
* (Any (combination of) {@include [AccessApiLink]}).
6161
*
62-
* This DSL comes in the form a [Columns Selector][ColumnsSelector] lambda,
62+
* This DSL is initiated by a [Columns Selector][ColumnsSelector] lambda,
6363
* which operates on the {@include [ColumnsSelectionDslLink]} and
6464
* expects you to return a [ColumnsResolver]; an entity formed by calling any (combination) of the functions
6565
* in the DSL that is or can be resolved into one or more columns.
@@ -92,7 +92,7 @@ internal interface SelectingColumns {
9292
* Select or express a single column using the Column Selection DSL.
9393
* (Any {@include [AccessApiLink]}).
9494
*
95-
* This DSL comes in the form of a [Column Selector][ColumnSelector] lambda,
95+
* This DSL is initiated by a [Column Selector][ColumnSelector] lambda,
9696
* which operates in the {@include [ColumnSelectionDslLink]} and
9797
* expects you to return a [SingleColumn].
9898
*

0 commit comments

Comments
 (0)