[PYSPARK][DOCS] [MINOR]Changed :func: to :attr: Sphinx roles, fixed links in documentation of Data{Frame,Stream}{Reader,Writer}.#27553
Closed
DavidToneian wants to merge 1 commit intoapache:masterfrom
Conversation
…on of `Data{Frame,Stream}{Reader,Writer}`.
This commit is published into the public domain.
maropu
changed the title
:func: to :attr: Sphinx roles, fixed links in documentation of Data{Frame,Stream}{Reader,Writer}.:func: to :attr: Sphinx roles, fixed links in documentation of Data{Frame,Stream}{Reader,Writer}.
Member
|
ok to test |
Member
|
cc: @HyukjinKwon |
HyukjinKwon
reviewed
Feb 13, 2020
HyukjinKwon
reviewed
Feb 13, 2020
HyukjinKwon
reviewed
Feb 13, 2020
|
Test build #118328 has finished for PR 27553 at commit
|
HyukjinKwon
pushed a commit
that referenced
this pull request
Feb 14, 2020
…ed links in documentation of `Data{Frame,Stream}{Reader,Writer}`
This commit is published into the public domain.
### What changes were proposed in this pull request?
This PR fixes the documentation of `DataFrameReader`, `DataFrameWriter`, `DataStreamReader`, and `DataStreamWriter`, where attributes of other classes were misrepresented as functions. Additionally, creation of hyperlinks across modules was fixed in these instances.
### Why are the changes needed?
The old state produced documentation that suggested invalid usage of PySpark objects (accessing attributes as though they were callable.)
### Does this PR introduce any user-facing change?
No, except for improved documentation.
### How was this patch tested?
No test added; documentation build runs through.
Closes #27553 from DavidToneian/docfix-DataFrameReader-DataFrameWriter-DataStreamReader-DataStreamWriter.
Authored-by: David Toneian <david@toneian.com>
Signed-off-by: HyukjinKwon <gurwls223@apache.org>
(cherry picked from commit 25db8c7)
Signed-off-by: HyukjinKwon <gurwls223@apache.org>
Member
|
Merged to master, branch-3.0 and branch-2.4. Thanks, @DavidToneian for the contribution. |
HyukjinKwon
pushed a commit
that referenced
this pull request
Feb 14, 2020
…ed links in documentation of `Data{Frame,Stream}{Reader,Writer}`
This commit is published into the public domain.
### What changes were proposed in this pull request?
This PR fixes the documentation of `DataFrameReader`, `DataFrameWriter`, `DataStreamReader`, and `DataStreamWriter`, where attributes of other classes were misrepresented as functions. Additionally, creation of hyperlinks across modules was fixed in these instances.
### Why are the changes needed?
The old state produced documentation that suggested invalid usage of PySpark objects (accessing attributes as though they were callable.)
### Does this PR introduce any user-facing change?
No, except for improved documentation.
### How was this patch tested?
No test added; documentation build runs through.
Closes #27553 from DavidToneian/docfix-DataFrameReader-DataFrameWriter-DataStreamReader-DataStreamWriter.
Authored-by: David Toneian <david@toneian.com>
Signed-off-by: HyukjinKwon <gurwls223@apache.org>
(cherry picked from commit 25db8c7)
Signed-off-by: HyukjinKwon <gurwls223@apache.org>
sjincho
pushed a commit
to sjincho/spark
that referenced
this pull request
Apr 15, 2020
…ed links in documentation of `Data{Frame,Stream}{Reader,Writer}`
This commit is published into the public domain.
### What changes were proposed in this pull request?
This PR fixes the documentation of `DataFrameReader`, `DataFrameWriter`, `DataStreamReader`, and `DataStreamWriter`, where attributes of other classes were misrepresented as functions. Additionally, creation of hyperlinks across modules was fixed in these instances.
### Why are the changes needed?
The old state produced documentation that suggested invalid usage of PySpark objects (accessing attributes as though they were callable.)
### Does this PR introduce any user-facing change?
No, except for improved documentation.
### How was this patch tested?
No test added; documentation build runs through.
Closes apache#27553 from DavidToneian/docfix-DataFrameReader-DataFrameWriter-DataStreamReader-DataStreamWriter.
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
4 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?
This PR fixes the documentation of
DataFrameReader,DataFrameWriter,DataStreamReader, andDataStreamWriter, where attributes of other classes were misrepresented as functions. Additionally, creation of hyperlinks across modules was fixed in these instances.Why are the changes needed?
The old state produced documentation that suggested invalid usage of PySpark objects (accessing attributes as though they were callable.)
Does this PR introduce any user-facing change?
No, except for improved documentation.
How was this patch tested?
No test added; documentation build runs through.