Skip to content

Commit

Permalink
[SPARK-36239][PYTHON][DOCS] Remove some APIs from documentation
Browse files Browse the repository at this point in the history
### 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>
  • Loading branch information
itholic authored and HyukjinKwon committed Jul 22, 2021
1 parent 900b72a commit 86471ad
Show file tree
Hide file tree
Showing 3 changed files with 0 additions and 9 deletions.
6 changes: 0 additions & 6 deletions python/docs/source/reference/pyspark.pandas/frame.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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
1 change: 0 additions & 1 deletion python/docs/source/reference/pyspark.pandas/indexing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 0 additions & 2 deletions python/docs/source/reference/pyspark.pandas/series.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 86471ad

Please sign in to comment.