[
https://issues.apache.org/jira/browse/SPARK-11219?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Bryan Cutler updated SPARK-11219:
---------------------------------
Description:
There are several different formats for describing params in PySpark.MLlib,
making it unclear what the preferred way to document is, i.e. vertical
alignment vs single line.
This is to agree on a format and make it consistent across PySpark.MLlib.
Following the discussion in SPARK-10560, using 2 lines with an indentation is
both readable and doesn't lead to changing many lines when adding/removing
parameters. If the parameter uses a default value, put this in parenthesis in
a new line under the description.
Example:
{noformat}
:param stepSize:
Step size for each iteration of gradient descent.
(default: 0.1)
:param numIterations:
Number of iterations run for each batch of data.
(default: 50)
{noformat}
was:
There are several different formats for describing params in PySpark.MLlib,
making it unclear what the preferred way to document is, i.e. vertical
alignment vs single line.
This is to agree on a format and make it consistent across PySpark.MLlib.
Following the discussion in SPARK-10560, using a 2 lines with an indentation is
both readable and doesn't lead to changing many lines when adding/removing
parameters.
Example:
{noformat}
:param stepSize:
Step size for each iteration of gradient descent.
(default: 0.1)
:param numIterations:
Number of iterations run for each batch of data.
(default: 50)
{noformat}
> Make Parameter Description Format Consistent in PySpark.MLlib
> -------------------------------------------------------------
>
> Key: SPARK-11219
> URL: https://issues.apache.org/jira/browse/SPARK-11219
> Project: Spark
> Issue Type: Documentation
> Components: Documentation, MLlib, PySpark
> Reporter: Bryan Cutler
> Priority: Trivial
>
> There are several different formats for describing params in PySpark.MLlib,
> making it unclear what the preferred way to document is, i.e. vertical
> alignment vs single line.
> This is to agree on a format and make it consistent across PySpark.MLlib.
> Following the discussion in SPARK-10560, using 2 lines with an indentation is
> both readable and doesn't lead to changing many lines when adding/removing
> parameters. If the parameter uses a default value, put this in parenthesis
> in a new line under the description.
> Example:
> {noformat}
> :param stepSize:
> Step size for each iteration of gradient descent.
> (default: 0.1)
> :param numIterations:
> Number of iterations run for each batch of data.
> (default: 50)
> {noformat}
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@spark.apache.org
For additional commands, e-mail: issues-h...@spark.apache.org
