docs: Clarify join behavior in DataFrame::join docs (#14393)

apache · Feb 1, 2025 · a0d42ed · a0d42ed
1 parent c33cb85
commit a0d42ed
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/datafusion/core/src/dataframe/mod.rs b/datafusion/core/src/dataframe/mod.rs
@@ -1004,7 +1004,9 @@ impl DataFrame {
     ///
     /// `left_cols` and `right_cols` are used to form "equijoin" predicates (see
     /// example below), which are then combined with the optional `filter`
-    /// expression.
+    /// expression. If `left_cols` and `right_cols` contain ambiguous column
+    /// references, they will be disambiguated by prioritizing the left relation
+    /// for `left_cols` and the right relation for `right_cols`.
     ///
     /// Note that in case of outer join, the `filter` is applied to only matched rows.
     ///