Skip to content

Commit 93b9d8c

Browse files
join kdocs fixes
1 parent 6d17b98 commit 93b9d8c

File tree

1 file changed

+9
-8
lines changed
  • core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api

1 file changed

+9
-8
lines changed

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

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,7 @@ public fun <A, B> DataFrame<A>.join(
123123
* dfLeft.{@get [JoinMethod] join}(dfRight, "name", "city")
124124
* ```
125125
*/
126+
@ExcludeFromSources
126127
private interface JoinStringApiExample
127128

128129
/**
@@ -239,8 +240,8 @@ public fun <A, B> DataFrame<A>.leftJoin(other: DataFrame<B>, vararg columns: Str
239240
leftJoin(other) { columns.toColumnSet() }
240241

241242
/**
242-
* Performs a [right join][JoinType.Right] of this [DataFrame] with [other][\other] [DataFrame]
243-
* using selected key columns.
243+
* Performs a [right join][JoinType.Right] of this [DataFrame] with the [other][\other] [DataFrame]
244+
* using the selected key columns.
244245
* @include [RightJoinTypeDocs]
245246
*
246247
* This is a shortcut for [join] with [JoinType.Right].
@@ -288,8 +289,8 @@ public fun <A, B> DataFrame<A>.rightJoin(other: DataFrame<B>, vararg columns: St
288289
rightJoin(other) { columns.toColumnSet() }
289290

290291
/**
291-
* Performs a [full join][JoinType.Full] of this [DataFrame] with [other][\other] [DataFrame]
292-
* using selected key columns.
292+
* Performs a [full join][JoinType.Full] of this [DataFrame] with the [other][\other] [DataFrame]
293+
* using the selected key columns.
293294
* @include [FullJoinTypeDocs]
294295
*
295296
* This is a shortcut for [join] with [JoinType.Full].
@@ -337,8 +338,8 @@ public fun <A, B> DataFrame<A>.fullJoin(other: DataFrame<B>, vararg columns: Str
337338
fullJoin(other) { columns.toColumnSet() }
338339

339340
/**
340-
* Performs a [filter join][JoinType.Filter] of this [DataFrame] with [other][\other] [DataFrame]
341-
* using selected key columns.
341+
* Performs a [filter join][JoinType.Filter] of this [DataFrame] with the [other][\other] [DataFrame]
342+
* using the selected key columns.
342343
* @include [FilterJoinTypeDocs]
343344
*
344345
* This is a shortcut for [join] with [JoinType.Filter].
@@ -386,8 +387,8 @@ public fun <A, B> DataFrame<A>.filterJoin(other: DataFrame<B>, vararg columns: S
386387
filterJoin(other) { columns.toColumnSet() }
387388

388389
/**
389-
* Performs an [exclude join][JoinType.Exclude] of this [DataFrame] with [other][\other] [DataFrame]
390-
* using selected key columns.
390+
* Performs an [exclude join][JoinType.Exclude] of this [DataFrame] with the [other][\other] [DataFrame]
391+
* using the selected key columns.
391392
* @include [ExcludeJoinTypeDocs]
392393
*
393394
* This is a shortcut for [join] with [JoinType.Exclude].

0 commit comments

Comments
 (0)