Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[SPARK-40559][PYTHON][DOCS][FOLLOW-UP] Fix the docstring and document both applyInArrows #44139

Closed
wants to merge 2 commits into from

Conversation

HyukjinKwon
Copy link
Member

What changes were proposed in this pull request?

This PR is a followup of #38624 that documents both applyInArrows with a docstring fix.

Why are the changes needed?

For end users to refer the API documentation.

Does this PR introduce any user-facing change?

No, the main change has not been released out yet.

How was this patch tested?

Existing CI, and documentation build.

Was this patch authored or co-authored using generative AI tooling?

No.

Copy link
Member

@dongjoon-hyun dongjoon-hyun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1, LGTM.

@@ -652,9 +651,9 @@ def applyInArrow(
Parameters
----------
func : function
a Python native function that takes two `pyarrow.Table`s, and
a Python native function that takes two `pyarrow.Table`\\s, and
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Otherwise, it fails as below:


/__w/spark/spark/python/pyspark/sql/pandas/group_ops.py:docstring of pyspark.sql.pandas.group_ops.PandasCogroupedOps.applyInArrow:73:Inline interpreted text or phrase reference start-string without end-string.

This is consistent with applyInPandas.

@dongjoon-hyun
Copy link
Member

Merged to master~

asl3 pushed a commit to asl3/spark that referenced this pull request Dec 5, 2023
… both applyInArrows

### What changes were proposed in this pull request?

This PR is a followup of apache#38624 that documents both applyInArrows with a docstring fix.

### Why are the changes needed?

For end users to refer the API documentation.

### Does this PR introduce _any_ user-facing change?

No, the main change has not been released out yet.

### How was this patch tested?

Existing CI, and documentation build.

### Was this patch authored or co-authored using generative AI tooling?

No.

Closes apache#44139 from HyukjinKwon/SPARK-40559-followup.

Authored-by: Hyukjin Kwon <gurwls223@apache.org>
Signed-off-by: Dongjoon Hyun <dhyun@apple.com>
dbatomic pushed a commit to dbatomic/spark that referenced this pull request Dec 11, 2023
… both applyInArrows

### What changes were proposed in this pull request?

This PR is a followup of apache#38624 that documents both applyInArrows with a docstring fix.

### Why are the changes needed?

For end users to refer the API documentation.

### Does this PR introduce _any_ user-facing change?

No, the main change has not been released out yet.

### How was this patch tested?

Existing CI, and documentation build.

### Was this patch authored or co-authored using generative AI tooling?

No.

Closes apache#44139 from HyukjinKwon/SPARK-40559-followup.

Authored-by: Hyukjin Kwon <gurwls223@apache.org>
Signed-off-by: Dongjoon Hyun <dhyun@apple.com>
@HyukjinKwon HyukjinKwon deleted the SPARK-40559-followup branch January 15, 2024 00:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants