Skip to content

Commit 5fa8398

Browse files
join types enum kdocs fixes
1 parent 9ccf88e commit 5fa8398

File tree

1 file changed

+12
-6
lines changed
  • core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api

1 file changed

+12
-6
lines changed

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

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -624,32 +624,38 @@ internal interface ExcludeJoinTypeDocs
624624
public enum class JoinType {
625625

626626
/**
627-
* @include [LeftJoinTypeDocs]
627+
* Includes all rows from the left [DataFrame]; matching rows are merged,
628+
* unmatched right-side values are filled with `null`.
628629
*/
629630
Left,
630631

631632
/**
632-
* @include [RightJoinTypeDocs]
633+
* Includes all rows from the right [DataFrame]; matching rows are merged,
634+
* unmatched left-side values are filled with `null`.
633635
*/
634636
Right,
635637

636638
/**
637-
* @include [InnerJoinTypeDocs]
639+
* Includes only matching rows from both [DataFrame]s;
640+
* rows are merged.
638641
*/
639642
Inner,
640643

641644
/**
642-
* @include [FilterJoinTypeDocs]
645+
* Includes only rows from the left [DataFrame] that have a match in the right one;
646+
* right-side columns are not merged.
643647
*/
644648
Filter,
645649

646650
/**
647-
* @include [FullJoinTypeDocs]
651+
* Includes all rows from both [DataFrame]s; matching rows are merged,
652+
* all mismatches are filled with `null`.
648653
*/
649654
Full,
650655

651656
/**
652-
* @include [ExcludeJoinTypeDocs]
657+
* Includes only rows from the left [DataFrame] that do *not* have a match in the right one;
658+
* right-side columns are not merged.
653659
*/
654660
Exclude,
655661
}

0 commit comments

Comments
 (0)