You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@spark.apache.org by rx...@apache.org on 2015/04/17 23:30:16 UTC

spark git commit: Minor fix to SPARK-6958: Improve Python docstring for DataFrame.sort.

Repository: spark
Updated Branches:
  refs/heads/master d305e686b -> a452c5921


Minor fix to SPARK-6958: Improve Python docstring for DataFrame.sort.

As a follow up PR to #5544.

cc davies

Author: Reynold Xin <rx...@databricks.com>

Closes #5558 from rxin/sort-doc-improvement and squashes the following commits:

f4c276f [Reynold Xin] Review feedback.
d2dcf24 [Reynold Xin] Minor fix to SPARK-6958: Improve Python docstring for DataFrame.sort.


Project: http://git-wip-us.apache.org/repos/asf/spark/repo
Commit: http://git-wip-us.apache.org/repos/asf/spark/commit/a452c592
Tree: http://git-wip-us.apache.org/repos/asf/spark/tree/a452c592
Diff: http://git-wip-us.apache.org/repos/asf/spark/diff/a452c592

Branch: refs/heads/master
Commit: a452c59210cf2c8ff8601cdb11401eea6dc14973
Parents: d305e68
Author: Reynold Xin <rx...@databricks.com>
Authored: Fri Apr 17 16:30:13 2015 -0500
Committer: Reynold Xin <rx...@databricks.com>
Committed: Fri Apr 17 16:30:13 2015 -0500

----------------------------------------------------------------------
 python/pyspark/sql/dataframe.py | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/spark/blob/a452c592/python/pyspark/sql/dataframe.py
----------------------------------------------------------------------
diff --git a/python/pyspark/sql/dataframe.py b/python/pyspark/sql/dataframe.py
index 326d22e..d70c5b0 100644
--- a/python/pyspark/sql/dataframe.py
+++ b/python/pyspark/sql/dataframe.py
@@ -489,8 +489,9 @@ class DataFrame(object):
         """Returns a new :class:`DataFrame` sorted by the specified column(s).
 
         :param cols: list of :class:`Column` or column names to sort by.
-        :param ascending: sort by ascending order or not, could be bool, int
-             or list of bool, int (default: True).
+        :param ascending: boolean or list of boolean (default True).
+            Sort ascending vs. descending. Specify list for multiple sort orders.
+            If a list is specified, length of the list must equal length of the `cols`.
 
         >>> df.sort(df.age.desc()).collect()
         [Row(age=5, name=u'Bob'), Row(age=2, name=u'Alice')]
@@ -519,7 +520,7 @@ class DataFrame(object):
             jcols = [jc if asc else jc.desc()
                      for asc, jc in zip(ascending, jcols)]
         else:
-            raise TypeError("ascending can only be bool or list, but got %s" % type(ascending))
+            raise TypeError("ascending can only be boolean or list, but got %s" % type(ascending))
 
         jdf = self._jdf.sort(self._jseq(jcols))
         return DataFrame(jdf, self.sql_ctx)


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