You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@spark.apache.org by gu...@apache.org on 2023/02/03 06:51:57 UTC

[spark] branch branch-3.2 updated: [MINOR][DOCS][PYTHON][PS] Fix the `.groupby()` method docstring

This is an automated email from the ASF dual-hosted git repository.

gurwls223 pushed a commit to branch branch-3.2
in repository https://gitbox.apache.org/repos/asf/spark.git


The following commit(s) were added to refs/heads/branch-3.2 by this push:
     new 8f22e314a20 [MINOR][DOCS][PYTHON][PS] Fix the `.groupby()` method docstring
8f22e314a20 is described below

commit 8f22e314a20d49319c03308545b861f0982946de
Author: Deepyaman Datta <de...@utexas.edu>
AuthorDate: Fri Feb 3 15:50:32 2023 +0900

    [MINOR][DOCS][PYTHON][PS] Fix the `.groupby()` method docstring
    
    ### What changes were proposed in this pull request?
    
    Update the docstring for the `.groupby()` method.
    
    ### Why are the changes needed?
    
    The `.groupby()` method accept a list of columns (or a single column), and a column is defined by a `Series` or name (`Label`). It's a bit confusing to say "using a Series of columns", because `Series` (capitalized) is a specific object that isn't actually used/reasonable to use here.
    
    ### Does this PR introduce _any_ user-facing change?
    
    Yes (documentation)
    
    ### How was this patch tested?
    
    N/A
    
    Closes #38625 from deepyaman/patch-3.
    
    Authored-by: Deepyaman Datta <de...@utexas.edu>
    Signed-off-by: Hyukjin Kwon <gu...@apache.org>
    (cherry picked from commit 71154dc1b35c7227ef9033fe5abc2a8b3f2d0990)
    Signed-off-by: Hyukjin Kwon <gu...@apache.org>
---
 python/pyspark/pandas/generic.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/python/pyspark/pandas/generic.py b/python/pyspark/pandas/generic.py
index ad3fcd74e57..8f62dbee897 100644
--- a/python/pyspark/pandas/generic.py
+++ b/python/pyspark/pandas/generic.py
@@ -2181,7 +2181,7 @@ class Frame(object, metaclass=ABCMeta):
         dropna: bool = True,
     ) -> "GroupBy[FrameLike]":
         """
-        Group DataFrame or Series using a Series of columns.
+        Group DataFrame or Series using one or more columns.
 
         A groupby operation involves some combination of splitting the
         object, applying a function, and combining the results. This can be


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