Skip to content

Commit e67a760

Browse files
authored
Note column names uniqueness constraint on join (#256)
* note uniqueness constraint on join * clarify raises
1 parent dfa9319 commit e67a760

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

spec/API_specification/dataframe_api/dataframe_object.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -944,6 +944,10 @@ def join(
944944
"""
945945
Join with other dataframe.
946946
947+
Other than the joining column name(s), no column name is allowed to appear in
948+
both `self` and `other`. Rename columns before calling `join` if necessary
949+
using :meth:`rename_columns`.
950+
947951
Parameters
948952
----------
949953
other : DataFrame
@@ -963,4 +967,10 @@ def join(
963967
Returns
964968
-------
965969
DataFrame
970+
971+
Raises
972+
------
973+
ValueError
974+
If, apart from `left_on` and `right_on`, there are any column names
975+
present in both `self` and `other`.
966976
"""

0 commit comments

Comments
 (0)