[SPARK-36239][PYTHON][DOCS] Remove some APIs from documentation. #33458
Conversation
This file contains 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
|
Test build #141396 has finished for PR 33458 at commit
|
|
Kubernetes integration test starting |
|
Kubernetes integration test status success |
|
Test build #141460 has finished for PR 33458 at commit
|
|
Kubernetes integration test starting |
|
Kubernetes integration test status success |
HyukjinKwon
approved these changes
Jul 22, 2021
|
Merged to master and branch-3.2. |
HyukjinKwon
pushed a commit
that referenced
this pull request
Jul 22, 2021
### What changes were proposed in this pull request? This PR proposes removing some APIs from pandas-on-Spark documentation. Because they can be easily workaround via Spark DataFrame or Column functions, so they might be removed In the future. ### Why are the changes needed? Because we don't want to expose some functions as a public API. ### Does this PR introduce _any_ user-facing change? The APIs such as `(Series|Index).spark.data_type`, `(Series|Index).spark.nullable`, `DataFrame.spark.schema`, `DataFrame.spark.print_schema`, `DataFrame.pandas_on_spark.attach_id_column`, `DataFrame.spark.checkpoint`, `DataFrame.spark.localcheckpoint` and `DataFrame.spark.explain` is removed in the documentation. ### How was this patch tested? Manually build the documents. Closes #33458 from itholic/SPARK-36239. Authored-by: itholic <haejoon.lee@databricks.com> Signed-off-by: Hyukjin Kwon <gurwls223@apache.org> (cherry picked from commit 86471ad) Signed-off-by: Hyukjin Kwon <gurwls223@apache.org>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 proposes removing some APIs from pandas-on-Spark documentation.
Because they can be easily workaround via Spark DataFrame or Column functions, so they might be removed In the future.
Why are the changes needed?
Because we don't want to expose some functions as a public API.
Does this PR introduce any user-facing change?
The APIs such as
(Series|Index).spark.data_type,(Series|Index).spark.nullable,DataFrame.spark.schema,DataFrame.spark.print_schema,DataFrame.pandas_on_spark.attach_id_column,DataFrame.spark.checkpoint,DataFrame.spark.localcheckpointandDataFrame.spark.explainis removed in the documentation.How was this patch tested?
Manually build the documents.