[ 
https://issues.apache.org/jira/browse/SPARK-21210?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Nick Pentreath updated SPARK-21210:
-----------------------------------
    Description: 
[PR 15999|https://github.com/apache/spark/pull/15999] included fixes for doc 
strings in the ML shared param traits ({{>}} and {{>=}} predominatly) - see 
[from 
here|https://github.com/apache/spark/pull/15999/files#diff-9edc669edcf2c0c7cf1efe4a0a57da80L32].

However, the changes were made directly to the traits, while the changes should 
have been made to {{SharedParamsCodeGen}}. So every time the code gen is run 
(i.e. whenever a new shared param trait is to be added), the fixes will be lost.

The changes also need to be made such that only the doc string is changed - the 
param doc that gets printed from {{explainParams}} can remain unchanged.

  was:
[PR 15999|https://github.com/apache/spark/pull/15999] included fixes for doc 
strings in the ML shared param traits ({{>}} and {{>=}} predominatly) - see 
[from 
here|https://github.com/apache/spark/pull/15999/files#diff-9edc669edcf2c0c7cf1efe4a0a57da80L32].

However, the changes were made directly to the traits, while the changes should 
have been made to {{SharedParamsCodeGen}}. So every time the code gen is run 
(i.e. whenever a new shared param trait is to be added), the fixes will be lost.


> Javadoc 8 fixes for ML shared param traits
> ------------------------------------------
>
>                 Key: SPARK-21210
>                 URL: https://issues.apache.org/jira/browse/SPARK-21210
>             Project: Spark
>          Issue Type: Improvement
>          Components: Documentation, ML
>    Affects Versions: 2.1.1, 2.2.0
>            Reporter: Nick Pentreath
>            Priority: Minor
>
> [PR 15999|https://github.com/apache/spark/pull/15999] included fixes for doc 
> strings in the ML shared param traits ({{>}} and {{>=}} predominatly) - see 
> [from 
> here|https://github.com/apache/spark/pull/15999/files#diff-9edc669edcf2c0c7cf1efe4a0a57da80L32].
> However, the changes were made directly to the traits, while the changes 
> should have been made to {{SharedParamsCodeGen}}. So every time the code gen 
> is run (i.e. whenever a new shared param trait is to be added), the fixes 
> will be lost.
> The changes also need to be made such that only the doc string is changed - 
> the param doc that gets printed from {{explainParams}} can remain unchanged.



--
This message was sent by Atlassian JIRA
(v6.4.14#64029)

---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@spark.apache.org
For additional commands, e-mail: issues-h...@spark.apache.org

Reply via email to