ODIn/spark-instrumented-optimizer
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
spark-instrumented-optimizer/python/docs/source/reference
History
Kousuke Saruta 8b2b6bb0d3 [SPARK-36865][PYTHON][DOCS] Add PySpark API document of session_window 
### What changes were proposed in this pull request?

This PR adds PySpark API document of `session_window`.
The docstring of the function doesn't comply with numpydoc format so this PR also fix it.
Further, the API document of `window` doesn't have `Parameters` section so it's also added in this PR.

### Why are the changes needed?

To provide PySpark users with the API document of the newly added function.

### Does this PR introduce _any_ user-facing change?

No.

### How was this patch tested?

`make html` in `python/docs` and get the following docs.

[window]
![time-window-python-doc-after](https://user-images.githubusercontent.com/4736016/134963797-ce25b268-20ca-48e3-ac8d-cbcbd85ebb3e.png)

[session_window]
![session-window-python-doc-after](https://user-images.githubusercontent.com/4736016/134963853-dd9d8417-139b-41ee-9924-14544b1a91af.png)

Closes #34118 from sarutak/python-session-window-doc.

Authored-by: Kousuke Saruta <sarutak@oss.nttdata.com>
Signed-off-by: Jungtaek Lim <kabhwan.opensource@gmail.com>
(cherry picked from commit 5a32e41e9c)
Signed-off-by: Jungtaek Lim <kabhwan.opensource@gmail.com>
2021-09-30 16:51:27 +09:00
..
pyspark.pandas [SPARK-36621][PYTHON][DOCS] Add Apache license headers to Pandas API on Spark documents 2021-09-02 12:35:51 +09:00
index.rst [SPARK-35636][PYTHON][DOCS][FOLLOW-UP] Restructure reference API files according to the layout 2021-06-08 19:01:56 +09:00
pyspark.ml.rst Revert "[SPARK-34415][ML] Randomization in hyperparameter optimization" 2021-08-24 13:39:29 -07:00
pyspark.mllib.rst [SPARK-34041][PYTHON][DOCS] Miscellaneous cleanup for new PySpark documentation 2021-01-08 09:28:31 +09:00
pyspark.resource.rst [SPARK-32179][SPARK-32188][PYTHON][DOCS] Replace and redesign the documentation base 2020-07-27 17:49:21 +09:00
pyspark.rst [SPARK-35303][PYTHON] Enable pinned thread mode by default 2021-06-18 12:02:29 +09:00
pyspark.sql.rst [SPARK-36865][PYTHON][DOCS] Add PySpark API document of session_window 2021-09-30 16:51:27 +09:00
pyspark.ss.rst [SPARK-32179][SPARK-32188][PYTHON][DOCS] Replace and redesign the documentation base 2020-07-27 17:49:21 +09:00
pyspark.streaming.rst [SPARK-32179][SPARK-32188][PYTHON][DOCS] Replace and redesign the documentation base 2020-07-27 17:49:21 +09:00