Skip to content

Commit 6d17b98

Browse files
join kdocs fixes
1 parent 5fa8398 commit 6d17b98

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ private interface JoinBehavior
6161
private interface JoinDocs
6262

6363
// `join` method used in the example
64-
@Suppress("ktlint:standard:class-naming")
64+
@Suppress("ClassName")
6565
@ExcludeFromSources
6666
private interface JOIN_METHOD
6767

@@ -141,7 +141,7 @@ public fun <A, B> DataFrame<A>.join(
141141
): DataFrame<A> = join(other, type) { columns.toColumnSet() }
142142

143143
/**
144-
* Performs a [inner join][JoinType.Inner] of this [DataFrame] with the [other][\other] [DataFrame]
144+
* Performs an [inner join][JoinType.Inner] of this [DataFrame] with the [other][\other] [DataFrame]
145145
* using the selected key columns.
146146
* @include [InnerJoinTypeDocs]
147147
*
@@ -386,7 +386,7 @@ public fun <A, B> DataFrame<A>.filterJoin(other: DataFrame<B>, vararg columns: S
386386
filterJoin(other) { columns.toColumnSet() }
387387

388388
/**
389-
* Performs a [exclude join][JoinType.Exclude] of this [DataFrame] with [other][\other] [DataFrame]
389+
* Performs an [exclude join][JoinType.Exclude] of this [DataFrame] with [other][\other] [DataFrame]
390390
* using selected key columns.
391391
* @include [ExcludeJoinTypeDocs]
392392
*

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ import org.jetbrains.kotlinx.dataframe.impl.api.joinWithImpl
2727
private interface JoinWithCommonDescription
2828

2929
// `joinWith` method used in the example
30-
@Suppress("ktlint:standard:class-naming")
30+
@Suppress("ClassName")
3131
@ExcludeFromSources
3232
private interface JOIN_WITH_METHOD
3333

@@ -109,7 +109,7 @@ public fun <A, B> DataFrame<A>.joinWith(
109109
): DataFrame<A> = joinWithImpl(right, type, addNewColumns = type.addNewColumns, joinExpression)
110110

111111
/**
112-
* Performs a [inner join][JoinType.Inner] of this [DataFrame] with the [right][\right] [DataFrame]
112+
* Performs an [inner join][JoinType.Inner] of this [DataFrame] with the [right][\right] [DataFrame]
113113
* using the provided [\joinExpression]. {@include [InnerJoinTypeDocs]}
114114
*
115115
* This is a shortcut for [joinWith] with [JoinType.Inner].
@@ -244,7 +244,7 @@ public fun <A, B> DataFrame<A>.filterJoinWith(right: DataFrame<B>, joinExpressio
244244
joinWithImpl(right, JoinType.Filter, addNewColumns = false, joinExpression)
245245

246246
/**
247-
* Performs a [exclude join][JoinType.Exclude] of this [DataFrame] with the [right][\right] [DataFrame]
247+
* Performs an [exclude join][JoinType.Exclude] of this [DataFrame] with the [right][\right] [DataFrame]
248248
* using the provided [\joinExpression]. {@include [ExcludeJoinTypeDocs]}
249249
*
250250
* This is a shortcut for [joinWith] with [JoinType.Exclude].

0 commit comments

Comments
 (0)