This is an automated email from the ASF dual-hosted git repository.
gurwls223 pushed a commit to branch branch-3.2
in repository https://gitbox.apache.org/repos/asf/spark.git
The following commit(s) were added to refs/heads/branch-3.2 by this push:
new 94479a2 [SPARK-36239][PYTHON][DOCS] Remove some APIs from
documentation
94479a2 is described below
commit 94479a23c1055365b5ee6068e5ba8b9863acc74e
Author: itholic <[email protected]>
AuthorDate: Thu Jul 22 19:46:40 2021 +0900
[SPARK-36239][PYTHON][DOCS] Remove some APIs from documentation
### 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 <[email protected]>
Signed-off-by: Hyukjin Kwon <[email protected]>
(cherry picked from commit 86471ad668d6eb1423c6c02eb59992fd608fd581)
Signed-off-by: Hyukjin Kwon <[email protected]>
---
python/docs/source/reference/pyspark.pandas/frame.rst | 6 ------
python/docs/source/reference/pyspark.pandas/indexing.rst | 1 -
python/docs/source/reference/pyspark.pandas/series.rst | 2 --
3 files changed, 9 deletions(-)
diff --git a/python/docs/source/reference/pyspark.pandas/frame.rst
b/python/docs/source/reference/pyspark.pandas/frame.rst
index 642bfd4..dbeee65 100644
--- a/python/docs/source/reference/pyspark.pandas/frame.rst
+++ b/python/docs/source/reference/pyspark.pandas/frame.rst
@@ -276,20 +276,15 @@ in Spark. These can be accessed by
``DataFrame.spark.<function/property>``.
.. autosummary::
:toctree: api/
- DataFrame.spark.schema
- DataFrame.spark.print_schema
DataFrame.spark.frame
DataFrame.spark.cache
DataFrame.spark.persist
DataFrame.spark.hint
DataFrame.spark.to_table
DataFrame.spark.to_spark_io
- DataFrame.spark.explain
DataFrame.spark.apply
DataFrame.spark.repartition
DataFrame.spark.coalesce
- DataFrame.spark.checkpoint
- DataFrame.spark.local_checkpoint
.. _api.dataframe.plot:
@@ -321,6 +316,5 @@ These can be accessed by
``DataFrame.pandas_on_spark.<function/property>``.
.. autosummary::
:toctree: api/
- DataFrame.pandas_on_spark.attach_id_column
DataFrame.pandas_on_spark.apply_batch
DataFrame.pandas_on_spark.transform_batch
diff --git a/python/docs/source/reference/pyspark.pandas/indexing.rst
b/python/docs/source/reference/pyspark.pandas/indexing.rst
index 60c4c4b..454d486 100644
--- a/python/docs/source/reference/pyspark.pandas/indexing.rst
+++ b/python/docs/source/reference/pyspark.pandas/indexing.rst
@@ -111,7 +111,6 @@ in Spark. These can be accessed by
``Index.spark.<function/property>``.
.. autosummary::
:toctree: api/
- Index.spark.data_type
Index.spark.column
Index.spark.transform
diff --git a/python/docs/source/reference/pyspark.pandas/series.rst
b/python/docs/source/reference/pyspark.pandas/series.rst
index fec89de..07944f2 100644
--- a/python/docs/source/reference/pyspark.pandas/series.rst
+++ b/python/docs/source/reference/pyspark.pandas/series.rst
@@ -249,8 +249,6 @@ in Spark. These can be accessed by
``Series.spark.<function/property>``.
.. autosummary::
:toctree: api/
- Series.spark.data_type
- Series.spark.nullable
Series.spark.column
Series.spark.transform
Series.spark.apply
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
