[SPARK-31748][PYTHON][3.0] Document resource module in PySpark doc and rename/move classes #28586
Conversation
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
…d rename/move classes
Member
Author
|
cc @dongjoon-hyun, can you take a quick look? |
This comment has been minimized.
This comment has been minimized.
|
Test build #122869 has finished for PR 28586 at commit
|
Member
Author
|
Merged to branch-3.0. Thanks. |
HyukjinKwon
added a commit
that referenced
this pull request
May 20, 2020
…d rename/move classes ### What changes were proposed in this pull request? This PR partially backports #28569. 1.. Rename ``` pyspark └── resourceinformation.py └── class ResourceInformation ``` to ``` pyspark └── resource.py └── class ResourceInformation ``` So, the `ResourceInformation` is consistently imported via `pyspark.resource.ResourceInformation`. 2.. Document the new `pyspark.resource` module 3.. Minor docstring fix e.g.: ```diff - param name the name of the resource - param addresses an array of strings describing the addresses of the resource + :param name: the name of the resource + :param addresses: an array of strings describing the addresses of the resource + + .. versionadded:: 3.0.0 ``` ### Why are the changes needed? To document APIs, and move Python modules to fewer and simpler modules. ### Does this PR introduce _any_ user-facing change? No, the changes are in unreleased branches. ### How was this patch tested? Manually tested via: ```bash cd python ./run-tests --python-executables=python3 --modules=pyspark-core ``` Closes #28586 from HyukjinKwon/SPARK-31748. Authored-by: HyukjinKwon <[email protected]> Signed-off-by: HyukjinKwon <[email protected]>
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.
What changes were proposed in this pull request?
This PR partially backports #28569.
1.. Rename
to
So, the
ResourceInformationis consistently imported viapyspark.resource.ResourceInformation.2.. Document the new
pyspark.resourcemodule3.. Minor docstring fix e.g.:
Why are the changes needed?
To document APIs, and move Python modules to fewer and simpler modules.
Does this PR introduce any user-facing change?
No, the changes are in unreleased branches.
How was this patch tested?
Manually tested via:
cd python ./run-tests --python-executables=python3 --modules=pyspark-core