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-31739][PYSPARK][DOCS][MINOR] Fix docstring syntax issues and misplaced space characters. #28559

Closed
wants to merge 2 commits into from

Conversation

DavidToneian
Copy link
Contributor

This commit is published into the public domain.

What changes were proposed in this pull request?

Some syntax issues in docstrings have been fixed.

Why are the changes needed?

In some places, the documentation did not render as intended, e.g. parameter documentations were not formatted as such.

Does this PR introduce any user-facing change?

Slight improvements in documentation.

How was this patch tested?

Manual testing and dev/lint-python run. No new Sphinx warnings arise due to this change.

@HyukjinKwon
Copy link
Member

ok to test

@SparkQA
Copy link

SparkQA commented May 18, 2020

Test build #122776 has finished for PR 28559 at commit 982ce47.

  • This patch passes all tests.
  • This patch merges cleanly.
  • This patch adds no public classes.


:param func: a function that takes and returns a class:`DataFrame`.
:param func: a function that takes and returns a :class:`DataFrame`.
Copy link
Member

Choose a reason for hiding this comment

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

Could you fix classification.py and regression.py, too?

pyspark/ml/classification.py:    To be mixed in with class:`pyspark.ml.JavaModel`
pyspark/ml/regression.py:    To be mixed in with class:`pyspark.ml.JavaModel`

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 (with one minor comment). Thank you, @DavidToneian .

@DavidToneian
Copy link
Contributor Author

@dongjoon-hyun Thanks for pointing those out, fixed in the new commit above.

@HyukjinKwon
Copy link
Member

HyukjinKwon commented May 18, 2020

Merged to master.

I will pick this up to branch-3.0 when RC is cut out.

@SparkQA
Copy link

SparkQA commented May 18, 2020

Test build #122802 has finished for PR 28559 at commit 239bf9c.

  • This patch passes all tests.
  • This patch merges cleanly.
  • This patch adds no public classes.

@HyukjinKwon
Copy link
Member

Merged to branch-3.0 as well.

HyukjinKwon pushed a commit that referenced this pull request May 19, 2020
…isplaced space characters

This commit is published into the public domain.

Some syntax issues in docstrings have been fixed.

In some places, the documentation did not render as intended, e.g. parameter documentations were not formatted as such.

Slight improvements in documentation.

Manual testing and `dev/lint-python` run. No new Sphinx warnings arise due to this change.

Closes #28559 from DavidToneian/SPARK-31739.

Authored-by: David Toneian <david@toneian.com>
Signed-off-by: HyukjinKwon <gurwls223@apache.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
5 participants