spark-instrumented-optimizer/python/docs/source/development
HyukjinKwon 5250841537
[SPARK-33256][PYTHON][DOCS] Clarify PySpark follows NumPy documentation style
### What changes were proposed in this pull request?

This PR adds few lines about docstring style to document that PySpark follows [NumPy documentation style](https://numpydoc.readthedocs.io/en/latest/format.html). We all completed the migration to NumPy documentation style at SPARK-32085.

Ideally we should have a page like https://pandas.pydata.org/docs/development/contributing_docstring.html but I would like to leave it as a future work.

### Why are the changes needed?

To tell developers that PySpark now follows NumPy documentation style.

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

No, it's a change in unreleased branches yet.

### How was this patch tested?

Manually tested via `make clean html` under `python/docs`:

![Screen Shot 2020-12-06 at 1 34 50 PM](https://user-images.githubusercontent.com/6477701/101271623-d5ce0380-37c7-11eb-93ac-da73caa50c37.png)

Closes #30622 from HyukjinKwon/SPARK-33256.

Authored-by: HyukjinKwon <gurwls223@apache.org>
Signed-off-by: Dongjoon Hyun <dongjoon@apache.org>
2020-12-06 01:22:24 -08:00
..
contributing.rst [SPARK-33256][PYTHON][DOCS] Clarify PySpark follows NumPy documentation style 2020-12-06 01:22:24 -08:00
debugging.rst Spelling r common dev mlib external project streaming resource managers python 2020-11-27 10:22:45 -06:00
index.rst [SPARK-32189][DOCS][PYTHON] Development - Setting up IDEs 2020-09-21 12:29:17 +09:00
setting_ide.rst [SPARK-32189][DOCS][PYTHON][FOLLOW-UP] Fixed broken link and typo in PySpark docs 2020-10-07 16:39:25 +09:00
testing.rst Spelling r common dev mlib external project streaming resource managers python 2020-11-27 10:22:45 -06:00