Skip to content

Commit d6d37ab

Browse files
author
Rik Huijzer
authored
Specify why leftjoin! needs at most one match (#2894)
1 parent 7705974 commit d6d37ab

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

src/join/inplace.jl

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,10 @@
66
Perform a left join of two data frame objects by updating the `df1` with the
77
joined columns from `df2`.
88
9-
A left join includes all rows from `df1`.
10-
Rows and columns from `df1` are left untouched.
11-
Each row in `df1` must have at most one match in `df2` based on `on` columns.
9+
A left join includes all rows from `df1` and leaves all rows and columns from `df1`
10+
untouched. Note that each row in `df1` must have at most one match in `df2`. Otherwise,
11+
this function would not be able to execute the join in-place since new rows would need to be
12+
added to `df1`.
1213
1314
# Arguments
1415
- `df1`, `df2`: the `AbstractDataFrames` to be joined

0 commit comments

Comments
 (0)