[ https://issues.apache.org/jira/browse/SPARK-47132?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17819777#comment-17819777 ]
Xinrong Meng commented on SPARK-47132: -------------------------------------- I modified the ticket to Documentation (from Bug) and 4.0.0 (from 3.5.0). > 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 > Priority: Trivial > Labels: pull-request-available > 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-unsubscr...@spark.apache.org For additional commands, e-mail: issues-h...@spark.apache.org