[SPARK-12184][PYTHON] Make python api doc for pivot consistant with s…

…cala doc In SPARK-11946 the API for pivot was changed a bit and got updated doc, the doc changes were not made for the python api though. This PR updates the python doc to be consistent. Author: Andrew Ray <[email protected]> Closes apache#10176 from aray/sql-pivot-python-doc.
markhamstra · Dec 7, 2015 · 36282f7 · 36282f7
1 parent 84b8094
commit 36282f7
Showing 1 changed file with 9 additions and 5 deletions.
diff --git a/python/pyspark/sql/group.py b/python/pyspark/sql/group.py
@@ -169,16 +169,20 @@ def sum(self, *cols):
 
     @since(1.6)
     def pivot(self, pivot_col, values=None):
-        """Pivots a column of the current DataFrame and perform the specified aggregation.
+        """
+        Pivots a column of the current [[DataFrame]] and perform the specified aggregation.
+        There are two versions of pivot function: one that requires the caller to specify the list
+        of distinct values to pivot on, and one that does not. The latter is more concise but less
+        efficient, because Spark needs to first compute the list of distinct values internally.
 
-        :param pivot_col: Column to pivot
-        :param values: Optional list of values of pivot column that will be translated to columns in
-            the output DataFrame. If values are not provided the method will do an immediate call
-            to .distinct() on the pivot column.
+        :param pivot_col: Name of the column to pivot.
+        :param values: List of values that will be translated to columns in the output DataFrame.
 
+        // Compute the sum of earnings for each year by course with each course as a separate column
         >>> df4.groupBy("year").pivot("course", ["dotNET", "Java"]).sum("earnings").collect()
         [Row(year=2012, dotNET=15000, Java=20000), Row(year=2013, dotNET=48000, Java=30000)]
 
+        // Or without specifying column values (less efficient)
         >>> df4.groupBy("year").pivot("course").sum("earnings").collect()
         [Row(year=2012, Java=20000, dotNET=15000), Row(year=2013, Java=30000, dotNET=48000)]
         """