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
Conversation
…isplaced space characters.
ok to test |
Test build #122776 has finished for PR 28559 at commit
|
|
||
:param func: a function that takes and returns a class:`DataFrame`. | ||
:param func: a function that takes and returns a :class:`DataFrame`. |
There was a problem hiding this comment.
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`
There was a problem hiding this 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 .
@dongjoon-hyun Thanks for pointing those out, fixed in the new commit above. |
Merged to master. I will pick this up to branch-3.0 when RC is cut out. |
Test build #122802 has finished for PR 28559 at commit
|
Merged to branch-3.0 as well. |
…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>
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.