[jira] [Created] (ARROW-18246) PyArrow table join docstring typos for left and right suffix arguments

["d33bs (Jira)" <ji...@apache.org>]

d33bs created ARROW-18246:
-----------------------------

             Summary: PyArrow table join docstring typos for left and right suffix arguments
                 Key: ARROW-18246
                 URL: https://issues.apache.org/jira/browse/ARROW-18246
             Project: Apache Arrow
          Issue Type: Bug
            Reporter: d33bs


Hello, thank you for all the amazing work on Arrow! I'd like to report a potential issue with PyArrow's Table Join docstring which may make it confusing for others to read. This content is I believe translated into the documentation website as well.

The content which needs to be corrected may be found starting at: [https://github.com/apache/arrow/blob/master/python/pyarrow/table.pxi#L4737]

The block currently reads:
{code:java}
left_suffix : str, default None
Which suffix to add to right 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
when the columns in left and right tables have colliding names.{code}

It could be improved with the following:
{code:java}
left_suffix : str, default None
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 suffix to add to the right column names. This prevents confusion
when the columns in left and right tables have colliding names.{code}

Please let me know if I may clarify or if there are any questions on the above. Thanks again for your help!

 



--
This message was sent by Atlassian Jira
(v8.20.10#820010)