[SPARK-31739][PYSPARK][DOCS][MINOR] Fix docstring syntax issues and misplaced space characters.#28559
Closed
DavidToneian wants to merge 2 commits intoapache:masterfrom
Closed
[SPARK-31739][PYSPARK][DOCS][MINOR] Fix docstring syntax issues and misplaced space characters.#28559DavidToneian wants to merge 2 commits intoapache:masterfrom
DavidToneian wants to merge 2 commits intoapache:masterfrom
Conversation
…isplaced space characters.
Member
|
ok to test |
HyukjinKwon
approved these changes
May 18, 2020
|
Test build #122776 has finished for PR 28559 at commit
|
srowen
approved these changes
May 18, 2020
| """Returns a new :class:`DataFrame`. Concise syntax for chaining custom transformations. | ||
|
|
||
| :param func: a function that takes and returns a class:`DataFrame`. | ||
| :param func: a function that takes and returns a :class:`DataFrame`. |
Member
There was a problem hiding this comment.
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`
dongjoon-hyun
approved these changes
May 18, 2020
Member
dongjoon-hyun
left a comment
dongjoon-hyun
left a comment
There was a problem hiding this comment.
+1, LGTM (with one minor comment). Thank you, @DavidToneian .
Contributor
Author
|
@dongjoon-hyun Thanks for pointing those out, fixed in the new commit above. |
Member
|
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
|
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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-pythonrun. No new Sphinx warnings arise due to this change.