[
https://issues.apache.org/jira/browse/SPARK-44728?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17757209#comment-17757209
]
Ruifeng Zheng edited comment on SPARK-44728 at 8/22/23 6:20 AM:
----------------------------------------------------------------
A docstring should contain the following sections:
# Brief Description: A concise summary explaining the function's purpose.
# Version Annotations: Annotations like versionadded and versionchanged to
signify the addition or modifications of the function in different versions of
the software.
# Parameters: This section should list and describe all input parameters. If
the function doesn't accept any parameters, this section can be omitted.
# Returns: Detail what the function returns. If the function doesn't return
anything, this section can be omitted.
# See Also: A list of related API functions or methods. This section can be
omitted if no related APIs exist.
# Notes: Include additional information or warnings about the function's usage
here.
# Examples:
## A docstring contains 3~5 examples if poosible.
## Every example should begin with a brief description, followed by the
example code, and conclude with the expected output.
## Every example should be copy-paste able;
## Any necessary import statements should be included at the beginning of each
example.
was (Author: podongfeng):
A docstring should contain the following sections:
# Brief Description: A concise summary explaining the function's purpose.
# Version Annotations: Annotations like versionadded and versionchanged to
signify the addition or modifications of the function in different versions of
the software.
# Parameters: This section should list and describe all input parameters. If
the function doesn't accept any parameters, this section can be omitted.
# Returns: Detail what the function returns. If the function doesn't return
anything, this section can be omitted.
# See Also: A list of related API functions or methods. This section can be
omitted if no related APIs exist.
# Notes: Include additional information or warnings about the function's usage
here.
# Examples: A docstring contains 3~5 examples if poosible.
## Every example should begin with a brief description, followed by the
example code, and conclude with the expected output.
## Every example should be copy-paste able;
## Any necessary import statements should be included at the beginning of each
example.
> Improve PySpark documentations
> ------------------------------
>
> Key: SPARK-44728
> URL: https://issues.apache.org/jira/browse/SPARK-44728
> Project: Spark
> Issue Type: Umbrella
> Components: PySpark
> Affects Versions: 3.5.0, 4.0.0
> Reporter: Allison Wang
> Priority: Major
>
> An umbrella Jira ticket to improve the PySpark documentation.
>
>
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@spark.apache.org
For additional commands, e-mail: issues-h...@spark.apache.org
