[SPARK-30859][PYSPARK][DOCS][MINOR] Fixed docstring syntax issues preventing proper compilation of documentation.#27613
Closed
DavidToneian wants to merge 2 commits intoapache:masterfrom
Closed
[SPARK-30859][PYSPARK][DOCS][MINOR] Fixed docstring syntax issues preventing proper compilation of documentation.#27613DavidToneian wants to merge 2 commits intoapache:masterfrom
DavidToneian wants to merge 2 commits intoapache:masterfrom
Conversation
…ion of documentation.
DavidToneian
changed the title
Member
|
ok to test |
Member
|
@DavidToneian, can you check if there are more instances to fix in PySpark API documentation? |
|
Test build #118602 has finished for PR 27613 at commit
|
Contributor
Author
|
@HyukjinKwon: These are the only instances I found when I searched for a space followed by a colon (" :") in the output HTML docs. |
HyukjinKwon
approved these changes
Feb 18, 2020
HyukjinKwon
pushed a commit
that referenced
this pull request
Feb 18, 2020
…venting proper compilation of documentation 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. No new Sphinx warnings arise due to this change. Closes #27613 from DavidToneian/SPARK-30859. Authored-by: David Toneian <david@toneian.com> Signed-off-by: HyukjinKwon <gurwls223@apache.org> (cherry picked from commit 504b513) Signed-off-by: HyukjinKwon <gurwls223@apache.org>
Member
|
Merged to master and branch-3.0. |
sjincho
pushed a commit
to sjincho/spark
that referenced
this pull request
Apr 15, 2020
…venting proper compilation of documentation 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. No new Sphinx warnings arise due to this change. Closes apache#27613 from DavidToneian/SPARK-30859. 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
3 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. No new Sphinx warnings arise due to this change.