[
https://issues.apache.org/jira/browse/SPARK-11219?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14992899#comment-14992899
]
Joseph K. Bradley commented on SPARK-11219:
-------------------------------------------
+1 for the format you show above
Should the default be at the end of the last line, or should it be on its own
line below? I'd prefer it have its own line, though I'd be OK with it at the
end if the description is a single line.
> 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 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)
> {noformat}
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
