Corey created SPARK-19734:
-----------------------------

             Summary: OneHotEncoder __init__ uses dropLast but doc strings all 
say includeFirst
                 Key: SPARK-19734
                 URL: https://issues.apache.org/jira/browse/SPARK-19734
             Project: Spark
          Issue Type: Documentation
          Components: PySpark
    Affects Versions: 2.1.0, 2.0.2, 1.6.3, 1.5.2
            Reporter: Corey
            Priority: Minor


The {{OneHotEncoder.__init__}} doc string in PySpark has an input keyword 
listed as {{includeFirst}}, whereas the code actually uses {{dropLast}}.

This especially confusing because the {{__init__}} function accepts only 
keywords, and following the documentation on the web 
(https://spark.apache.org/docs/2.0.1/api/python/pyspark.ml.html#pyspark.ml.feature.OneHotEncoder)
 or of {{help}} in Python will result in the error:
{quote}
TypeError: __init__() got an unexpected keyword argument 'includeFirst'
{quote}

The error is immediately viewable in the source code:
{code}
    @keyword_only
    def __init__(self, dropLast=True, inputCol=None, outputCol=None):
        """
        __init__(self, includeFirst=True, inputCol=None, outputCol=None)
        """
{code}





--
This message was sent by Atlassian JIRA
(v6.3.15#6346)

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

Reply via email to