Github user MLnick commented on the pull request:

    https://github.com/apache/spark/pull/12914#issuecomment-218187728
  
    Darn - it would have been a really simple solution.
    
    I'm not against having them as properties - the issue is the duplication 
you see, e.g.
    ```
    _maxIter = Param(Params._dummy(), "maxIter", "max number of iterations (>= 
0).", typeConverter=TypeConverters.toInt)
    maxIter = property(lambda x: x._maxIter, doc="Param maxIter, max number of 
iterations (>= 0).")
    ```
    
    Not sure if @jkbradley / @davies has other thoughts or ideas on the 
property issue? It just seems like a large-ish change for perhaps not that much 
benefit.
    
    The other option is just to restore the previous doc behavior we had of 
including the `_init_` doc string in the class doc. I'm not sure if a version 
change of sphinx changed default behavior, but it appears we can restore it by 
adding this line to `conf.py`: `autoclass_content = 'both'`.
    
    It's not ideal but it takes us back to what we had before, and at least the 
defaults for each param are fairly clearly documented in that way.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

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

Reply via email to