Skip to content

Commit f1526fc

Browse files
committed
clean up labelling
1 parent c00fe04 commit f1526fc

File tree

3 files changed

+15
-13
lines changed

3 files changed

+15
-13
lines changed

R/pkg/R/DataFrame.R

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2313,10 +2313,9 @@ setMethod("dropDuplicates",
23132313
#' @param joinExpr (Optional) The expression used to perform the join. joinExpr must be a
23142314
#' Column expression. If joinExpr is omitted, the default, inner join is attempted and an error is
23152315
#' thrown if it would be a Cartesian Product. For Cartesian join, use crossJoin instead.
2316-
#' @param joinType The type of join to perform. The following join types are available:
2317-
#' 'inner', 'cross', 'outer', 'full', 'full_outer', 'left', 'left_outer',
2318-
#' 'right', 'right_outer', 'left_semi', 'left_anti', 'cross'.
2319-
#' and 'cross'. The default joinType is "inner".
2316+
#' @param joinType The type of join to perform, default 'inner'.
2317+
#' Must be one of: 'inner', 'cross', 'outer', 'full', 'full_outer',
2318+
#' 'left', 'left_outer', 'right', 'right_outer', 'left_semi', and 'left_anti'.
23202319
#' @return A SparkDataFrame containing the result of the join operation.
23212320
#' @family SparkDataFrame functions
23222321
#' @aliases join,SparkDataFrame,SparkDataFrame-method

python/pyspark/sql/dataframe.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -730,9 +730,9 @@ def join(self, other, on=None, how=None):
730730
a join expression (Column), or a list of Columns.
731731
If `on` is a string or a list of strings indicating the name of the join column(s),
732732
the column(s) must exist on both sides, and this performs an equi-join.
733-
:param how: str, default 'inner'. Can be any of: `inner`, `cross`, `outer`,
734-
`full`, `full_outer`, `left`, `left_outer`, `right`, `right_outer`,
735-
`left_semi`, `left_anti`, `cross`.
733+
:param how: str, default ``inner``. Must be any of: ``inner``, ``cross``, ``outer``,
734+
``full``, ``full_outer``, ``left``, ``left_outer``, ``right``, ``right_outer``,
735+
``left_semi``, and ``left_anti``.
736736
737737
The following performs a full outer join between ``df1`` and ``df2``.
738738

sql/core/src/main/scala/org/apache/spark/sql/Dataset.scala

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -759,8 +759,9 @@ class Dataset[T] private[sql](
759759
*
760760
* @param right Right side of the join operation.
761761
* @param usingColumns Names of the columns to join on. This columns must exist on both sides.
762-
* @param joinType One of: `inner`, `cross`, `outer`, `full`, `full_outer`,
763-
* `left`, `left_outer`, `right`, `right_outer`, `left_semi`, `left_anti`.
762+
* @param joinType Type of join to perform. Default `inner`. Must be any of:
763+
* `inner`, `cross`, `outer`, `full`, `full_outer`, `left`, `left_outer`,
764+
* `right`, `right_outer`, `left_semi`, `left_anti`.
764765
*
765766
* @note If you perform a self-join using this function without aliasing the input
766767
* `DataFrame`s, you will NOT be able to reference any columns after the join, since
@@ -815,8 +816,9 @@ class Dataset[T] private[sql](
815816
*
816817
* @param right Right side of the join.
817818
* @param joinExprs Join expression.
818-
* @param joinType One of: `inner`, `cross`, `outer`, `full`, `full_outer`,
819-
* `left`, `left_outer`, `right`, `right_outer`, `left_semi`, `left_anti`.
819+
* @param joinType Type of join to perform. Default `inner`. Must be any of:
820+
* `inner`, `cross`, `outer`, `full`, `full_outer`, `left`, `left_outer`,
821+
* `right`, `right_outer`, `left_semi`, `left_anti`.
820822
*
821823
* @group untypedrel
822824
* @since 2.0.0
@@ -893,8 +895,9 @@ class Dataset[T] private[sql](
893895
*
894896
* @param other Right side of the join.
895897
* @param condition Join expression.
896-
* @param joinType One of: `inner`, `cross`, `outer`, `full`, `full_outer`,
897-
* `left`, `left_outer`, `right`, `right_outer`, `left_semi`, `left_anti`.
898+
* @param joinType Type of join to perform. Default `inner`. Must be any of:
899+
* `inner`, `cross`, `outer`, `full`, `full_outer`, `left`, `left_outer`,
900+
* `right`, `right_outer`, `left_semi`, `left_anti`.
898901
*
899902
* @group typedrel
900903
* @since 1.6.0

0 commit comments

Comments
 (0)