timsaucer commented on code in PR #912:
URL: https://github.com/apache/datafusion-python/pull/912#discussion_r1798320329
##########
python/datafusion/dataframe.py:
##########
@@ -284,14 +324,41 @@ def join(
Args:
right: Other DataFrame to join with.
- join_keys: Tuple of two lists of column names to join on.
+ on: Column names to join on in both dataframes.
how: Type of join to perform. Supported types are "inner", "left",
"right", "full", "semi", "anti".
+ left_on: Join column of the left dataframe.
+ right_on: Join column of the right dataframe.
+ join_keys: Tuple of two lists of column names to join on.
[Deprecated]
Review Comment:
With this addition, there are a set of mutually exclusive ways the user can
call. You've done a very nice job of providing warnings when they are used
incorrectly, but it would be very helpful to explain in the docstring that the
user should provide either on OR both left_on and right_on.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscr...@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscr...@datafusion.apache.org
For additional commands, e-mail: github-h...@datafusion.apache.org
