📝 Update doc for argument by for join functions (#62)

pwwang · Sep 26, 2021 · aa90055 · aa90055
1 parent 6d11fca
commit aa90055
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/datar/dplyr/join.py b/datar/dplyr/join.py
@@ -101,6 +101,8 @@ def inner_join(
     Args:
         x, y: A pair of data frames
         by: A character vector of variables to join by.
+            If keys from `x` and `y` are different, use a dict
+            (i.e. `{"colX": "colY"}`) instead of a list.
         copy: If x and y are not from the same data source, and copy is
             TRUE, then y will be copied into the same src as x.
             This allows you to join tables across srcs, but it is a