Hyukjin Kwon created SPARK-33247:
------------------------------------
Summary: Improve examples and scenarios in docstrings
Key: SPARK-33247
URL: https://issues.apache.org/jira/browse/SPARK-33247
Project: Spark
Issue Type: Improvement
Components: Documentation, PySpark
Affects Versions: 3.1.0
Reporter: Hyukjin Kwon
Currently, PySpark documentation does not have a lot of examples and scenarios.
See also https://github.com/apache/spark/pull/30149#issuecomment-716490037.
We should add/improve examples especially in the commonly used APIs. For
example, {{Column}}, {{DataFrame}}. {{RDD}}, {{SparkContext}}, etc.
This umbrella JIRA targets to improve them in commonly used APIs.
NOTE that we'll have to convert the docstrings into numpydoc style first in a
separate PR (at SPARK-32085), and then add examples. In this way, we can manage
migration to numpydoc and example improvement here separately (e.g., reverting
numpydoc migration only).
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
