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 2022/07/19 08:52:49 UTC
[spark] branch master updated: [MINOR][PYTHON][DOCS] Fix broken Example section in col/column functions
This is an automated email from the ASF dual-hosted git repository.
gurwls223 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/spark.git
The following commit(s) were added to refs/heads/master by this push:
new 2bdb5bfa48d [MINOR][PYTHON][DOCS] Fix broken Example section in col/column functions
2bdb5bfa48d is described below
commit 2bdb5bfa48d1fc44358c49f7e379c2afc4a1a32f
Author: Hyukjin Kwon <gu...@apache.org>
AuthorDate: Tue Jul 19 17:52:32 2022 +0900
[MINOR][PYTHON][DOCS] Fix broken Example section in col/column functions
### What changes were proposed in this pull request?
This PR fixes a bug in the documentation. Trailing `'` breaks Example section in Python reference documentation. This PR removes it.
### Why are the changes needed?
To render the documentation as intended in NumPy documentation style.
### Does this PR introduce _any_ user-facing change?
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">
### How was this patch tested?
Manually built the documentation and tested.
Closes #37223 from HyukjinKwon/minor-doc-fx.
Authored-by: Hyukjin Kwon <gu...@apache.org>
Signed-off-by: Hyukjin Kwon <gu...@apache.org>
---
python/pyspark/sql/functions.py | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/python/pyspark/sql/functions.py b/python/pyspark/sql/functions.py
index db99dbfc400..2997be08872 100644
--- a/python/pyspark/sql/functions.py
+++ b/python/pyspark/sql/functions.py
@@ -140,7 +140,7 @@ 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
--------
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@spark.apache.org
For additional commands, e-mail: commits-help@spark.apache.org