You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@spark.apache.org by "Kent Yao (Jira)" <ji...@apache.org> on 2024/02/28 10:30:00 UTC

[jira] [Assigned] (SPARK-47132) Mistake in Docstring for Pyspark's Dataframe.head()

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

Kent Yao reassigned SPARK-47132:
--------------------------------

    Assignee: Albert Ziegler

> Mistake in Docstring for Pyspark's Dataframe.head()
> ---------------------------------------------------
>
>                 Key: SPARK-47132
>                 URL: https://issues.apache.org/jira/browse/SPARK-47132
>             Project: Spark
>          Issue Type: Documentation
>          Components: PySpark
>    Affects Versions: 4.0.0
>            Reporter: Albert Ziegler
>            Assignee: Albert Ziegler
>            Priority: Trivial
>              Labels: pull-request-available
>         Attachments: image-2024-02-22-11-18-02-429.png, image-2024-02-22-11-21-30-460.png
>
>   Original Estimate: 0.5h
>  Remaining Estimate: 0.5h
>
> The docstring claims that {{head(n)}} would return a {{Row}} (rather than a list of rows) iff n == 1, but that's incorrect.
> Type hints, example, and implementation show that the difference between row or list of rows lies in whether n is supplied at all -- if it isn't, {{head()}} returns a {{{}Row{}}}, if it is, even if it is 1, {{head(n)}} returns a list.
>  
> A suggestion to fix is here: https://github.com/apache/spark/pull/45197



--
This message was sent by Atlassian Jira
(v8.20.10#820010)

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