This is an automated email from the ASF dual-hosted git repository.
jorisvandenbossche pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/arrow.git
The following commit(s) were added to refs/heads/master by this push:
new 0fb8d413e8 ARROW-18246: [Python][Docs] PyArrow table join docstring
typos for left and right suffix arguments (#14591)
0fb8d413e8 is described below
commit 0fb8d413e831d28af9ff41be687ac71b36feb540
Author: Will Jones <[email protected]>
AuthorDate: Wed Nov 9 02:04:58 2022 -0800
ARROW-18246: [Python][Docs] PyArrow table join docstring typos for left and
right suffix arguments (#14591)
Authored-by: Will Jones <[email protected]>
Signed-off-by: Joris Van den Bossche <[email protected]>
---
python/pyarrow/_exec_plan.pyx | 8 ++++----
python/pyarrow/table.pxi | 6 +++---
2 files changed, 7 insertions(+), 7 deletions(-)
diff --git a/python/pyarrow/_exec_plan.pyx b/python/pyarrow/_exec_plan.pyx
index 526e4cb73a..167a5030f5 100644
--- a/python/pyarrow/_exec_plan.pyx
+++ b/python/pyarrow/_exec_plan.pyx
@@ -52,7 +52,7 @@ cdef execplan(inputs, output_type, vector[CDeclaration] plan,
c_bool use_threads
The nodes of the plan that should be applied to the sources
to produce the output.
use_threads : bool, default True
- Whenever to use multithreading or not.
+ Whether to use multithreading or not.
"""
cdef:
CExecutor *c_executor
@@ -187,13 +187,13 @@ def _perform_join(join_type, left_operand not None,
left_keys,
right_keys : str or list[str]
The right key (or keys) on which the join operation should be
performed.
left_suffix : str, default None
- Which suffix to add to right column names. This prevents confusion
+ Which suffix to add to left column names. This prevents confusion
when the columns in left and right operands have colliding names.
right_suffix : str, default None
- Which suffic to add to the left column names. This prevents confusion
+ Which suffix to add to the right column names. This prevents confusion
when the columns in left and right operands have colliding names.
use_threads : bool, default True
- Whenever to use multithreading or not.
+ Whether to use multithreading or not.
coalesce_keys : bool, default False
If the duplicated keys should be omitted from one of the sides
in the join result.
diff --git a/python/pyarrow/table.pxi b/python/pyarrow/table.pxi
index 446c7f7c55..5c58ae61f1 100644
--- a/python/pyarrow/table.pxi
+++ b/python/pyarrow/table.pxi
@@ -4735,16 +4735,16 @@ cdef class Table(_PandasConvertible):
("left semi", "right semi", "left anti", "right anti",
"inner", "left outer", "right outer", "full outer")
left_suffix : str, default None
- Which suffix to add to right column names. This prevents confusion
+ Which suffix to add to left column names. This prevents confusion
when the columns in left and right tables have colliding names.
right_suffix : str, default None
- Which suffic to add to the left column names. This prevents
confusion
+ Which suffix to add to the right column names. This prevents
confusion
when the columns in left and right tables have colliding names.
coalesce_keys : bool, default True
If the duplicated keys should be omitted from one of the sides
in the join result.
use_threads : bool, default True
- Whenever to use multithreading or not.
+ Whether to use multithreading or not.
Returns
-------
