[ARROW-18246] [Python][Docs] PyArrow table join docstring typos for left and right suffix arguments

• Type: Bug
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Fix Version/s: 11.0.0
• Component/s: Documentation
• Labels: docs-impacting documentation pull-request-available
• External issue URL: https://github.com/apache/arrow/issues/33429
• Assignee: Will Jones
• Reporter: Will Jones
• Created: 03/Nov/22 22:40
• Updated: 11/Jan/23 11:59
• Resolved: 09/Nov/22 10:05

Description

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:

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.

It could be improved with the following:

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.

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

 

Issue Links

• links to: GitHub Pull Request #14591