[SPARK-47891] Improve docstring of mapInPandas

• Type: Sub-task
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 4.0.0
• Fix Version/s: 4.0.0
• Component/s: Documentation, PySpark
• Labels: pull-request-available
• Assignee: Xinrong Meng
• Reporter: Xinrong Meng
• Created: 17/Apr/24 21:12
• Updated: 18/Apr/24 19:26
• Resolved: 18/Apr/24 00:47

Description

Improve docstring of mapInPandas

• "using a Python native function that takes and outputs a pandas DataFrame" is confusing cause the function takes and outputs "ITERATOR of pandas DataFrames" instead.
• "All columns are passed together as an iterator of pandas DataFrames" easily mislead users to think the entire DataFrame will be passed together, "a batch of rows" is used instead.

Issue Links

• links to: GitHub Pull Request #46108