[spark] branch branch-3.3 updated: [MINOR][PYTHON][DOCS] Fix broken Example section in col/column functions

[gurwls223]

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

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


The following commit(s) were added to refs/heads/branch-3.3 by this push:
     new dcaa6e0eb6d [MINOR][PYTHON][DOCS] Fix broken Example section in 
col/column functions
dcaa6e0eb6d is described below

commit dcaa6e0eb6d5b4c90df64b5396ec0d31e7c9f99a
Author: Hyukjin Kwon <gurwls...@apache.org>
AuthorDate: Tue Jul 19 17:52:32 2022 +0900

    [MINOR][PYTHON][DOCS] Fix broken Example section in col/column functions
    
    This PR fixes a bug in the documentation. Trailing `'` breaks Example 
section in Python reference documentation. This PR removes it.
    
    To render the documentation as intended in NumPy documentation style.
    
    Yes, the documentation is updated.
    
    **Before**
    
    <img width="789" alt="Screen Shot 2022-07-19 at 12 20 55 PM" 
src="https://user-images.githubusercontent.com/6477701/179661216-715dec96-bff2-474f-ab48-41577bf4c15c.png";>
    
    **After**
    
    <img width="633" alt="Screen Shot 2022-07-19 at 12 48 04 PM" 
src="https://user-images.githubusercontent.com/6477701/179661245-72d15184-aeed-43c2-b9c9-5f3cab1ae28d.png";>
    
    Manually built the documentation and tested.
    
    Closes #37223 from HyukjinKwon/minor-doc-fx.
    
    Authored-by: Hyukjin Kwon <gurwls...@apache.org>
    Signed-off-by: Hyukjin Kwon <gurwls...@apache.org>
    (cherry picked from commit 2bdb5bfa48d1fc44358c49f7e379c2afc4a1a32f)
    Signed-off-by: Hyukjin Kwon <gurwls...@apache.org>
---
 python/pyspark/sql/functions.py | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/python/pyspark/sql/functions.py b/python/pyspark/sql/functions.py
index 019f64b5171..ed3b0789b47 100644
--- a/python/pyspark/sql/functions.py
+++ b/python/pyspark/sql/functions.py
@@ -140,7 +140,8 @@ def lit(col: Any) -> Column:
 @since(1.3)
 def col(col: str) -> Column:
     """
-    Returns a :class:`~pyspark.sql.Column` based on the given column name.'
+    Returns a :class:`~pyspark.sql.Column` based on the given column name.
+
     Examples
     --------
     >>> col('x')


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