You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@spark.apache.org by "panbingkun (via GitHub)" <gi...@apache.org> on 2024/01/02 09:19:42 UTC
[PR] [SPARK-46560][PYTHON][DOCS] Refine docstring `reverse/map_contains_key` [spark]
panbingkun opened a new pull request, #44561:
URL: https://github.com/apache/spark/pull/44561
<!--
Thanks for sending a pull request! Here are some tips for you:
1. If this is your first time, please read our contributor guidelines: https://spark.apache.org/contributing.html
2. Ensure you have added or run the appropriate tests for your PR: https://spark.apache.org/developer-tools.html
3. If the PR is unfinished, add '[WIP]' in your PR title, e.g., '[WIP][SPARK-XXXX] Your PR title ...'.
4. Be sure to keep the PR description updated to reflect all changes.
5. Please write your PR title to summarize what this PR proposes.
6. If possible, provide a concise example to reproduce the issue for a faster review.
7. If you want to add a new configuration, please read the guideline first for naming configurations in
'core/src/main/scala/org/apache/spark/internal/config/ConfigEntry.scala'.
8. If you want to add or modify an error type or message, please read the guideline first in
'core/src/main/resources/error/README.md'.
-->
### What changes were proposed in this pull request?
<!--
Please clarify what changes you are proposing. The purpose of this section is to outline the changes and how this PR fixes the issue.
If possible, please consider writing useful notes for better and faster reviews in your PR. See the examples below.
1. If you refactor some codes with changing classes, showing the class hierarchy will help reviewers.
2. If you fix some SQL features, you can provide some references of other DBMSes.
3. If there is design documentation, please add the link.
4. If there is a discussion in the mailing list, please add the link.
-->
### Why are the changes needed?
<!--
Please clarify why the changes are needed. For instance,
1. If you propose a new API, clarify the use case for a new API.
2. If you fix a bug, you can clarify why it is a bug.
-->
### Does this PR introduce _any_ user-facing change?
<!--
Note that it means *any* user-facing change including all aspects such as the documentation fix.
If yes, please clarify the previous behavior and the change this PR proposes - provide the console output, description and/or an example to show the behavior difference if possible.
If possible, please also clarify if this is a user-facing change compared to the released Spark versions or within the unreleased branches such as master.
If no, write 'No'.
-->
### How was this patch tested?
<!--
If tests were added, say they were added here. Please make sure to add some test cases that check the changes thoroughly including negative and positive cases if possible.
If it was tested in a way different from regular unit tests, please clarify how you tested step by step, ideally copy and paste-able, so that other reviewers can test and check, and descendants can verify in the future.
If tests were not added, please describe why they were not added and/or why it was difficult to add.
If benchmark tests were added, please run the benchmarks in GitHub Actions for the consistent environment, and the instructions could accord to: https://spark.apache.org/developer-tools.html#github-workflow-benchmarks.
-->
### Was this patch authored or co-authored using generative AI tooling?
<!--
If generative AI tooling has been used in the process of authoring this patch, please include the
phrase: 'Generated-by: ' followed by the name of the tool and its version.
If no, write 'No'.
Please refer to the [ASF Generative Tooling Guidance](https://www.apache.org/legal/generative-tooling.html) for details.
-->
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-46560][PYTHON][DOCS] Refine docstring `reverse/map_contains_key` [spark]
Posted by "panbingkun (via GitHub)" <gi...@apache.org>.
panbingkun commented on code in PR #44561:
URL: https://github.com/apache/spark/pull/44561#discussion_r1442426412
##########
python/pyspark/sql/functions/builtin.py:
##########
@@ -15313,21 +15313,39 @@ def reverse(col: "ColumnOrName") -> Column:
Parameters
----------
col : :class:`~pyspark.sql.Column` or str
- name of column or expression
+ The name of the column or an expression that represents the element to be reversed.
Returns
-------
:class:`~pyspark.sql.Column`
- array of elements in reverse order.
+ A new column that contains a reversed string or an array with elements in reverse order.
Examples
--------
+ Example 1: Reverse a string
+
+ >>> import pyspark.sql.functions as sf
>>> df = spark.createDataFrame([('Spark SQL',)], ['data'])
- >>> df.select(reverse(df.data).alias('s')).collect()
- [Row(s='LQS krapS')]
+ >>> df.select(sf.reverse(df.data)).show()
+ +-------------+
+ |reverse(data)|
+ +-------------+
+ | LQS krapS|
+ +-------------+
+
+ Example 2: Reverse an array
+
+ >>> df = spark.createDataFrame([([2, 1, 3],) ,([1],) ,([],)], ['data'])
Review Comment:
Oh, I made a mistake. It was defined twice in this example and let me to remove it.
Done.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-46560][PYTHON][DOCS] Refine docstring `reverse/map_contains_key` [spark]
Posted by "panbingkun (via GitHub)" <gi...@apache.org>.
panbingkun commented on code in PR #44561:
URL: https://github.com/apache/spark/pull/44561#discussion_r1440094747
##########
python/pyspark/sql/functions/builtin.py:
##########
@@ -15427,15 +15443,20 @@ def map_contains_key(col: "ColumnOrName", value: Any) -> Column:
Examples
--------
- >>> from pyspark.sql.functions import map_contains_key
+ Example 1: The key is in the map
+
+ >>> from pyspark.sql import functions as sf
>>> df = spark.sql("SELECT map(1, 'a', 2, 'b') as data")
- >>> df.select(map_contains_key("data", 1)).show()
+ >>> df.select(sf.map_contains_key("data", 1)).show()
+-------------------------+
|map_contains_key(data, 1)|
+-------------------------+
| true|
+-------------------------+
- >>> df.select(map_contains_key("data", -1)).show()
+
+ Example 2: The key is not in the map
+
+ >>> df.select(sf.map_contains_key("data", -1)).show()
Review Comment:
Do we need to make each example self-contained now?
I remember writing this way before, it was suggested not to write duplicate but reusable code in every example.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-46560][PYTHON][DOCS] Refine docstring `reverse/map_contains_key` [spark]
Posted by "panbingkun (via GitHub)" <gi...@apache.org>.
panbingkun commented on code in PR #44561:
URL: https://github.com/apache/spark/pull/44561#discussion_r1442416991
##########
python/pyspark/sql/functions/builtin.py:
##########
@@ -15313,21 +15313,39 @@ def reverse(col: "ColumnOrName") -> Column:
Parameters
----------
col : :class:`~pyspark.sql.Column` or str
- name of column or expression
+ The name of the column or an expression that represents the element to be reversed.
Returns
-------
:class:`~pyspark.sql.Column`
- array of elements in reverse order.
+ A new column that contains a reversed string or an array with elements in reverse order.
Examples
--------
+ Example 1: Reverse a string
+
+ >>> import pyspark.sql.functions as sf
>>> df = spark.createDataFrame([('Spark SQL',)], ['data'])
- >>> df.select(reverse(df.data).alias('s')).collect()
- [Row(s='LQS krapS')]
+ >>> df.select(sf.reverse(df.data)).show()
+ +-------------+
+ |reverse(data)|
+ +-------------+
+ | LQS krapS|
+ +-------------+
+
+ Example 2: Reverse an array
+
+ >>> df = spark.createDataFrame([([2, 1, 3],) ,([1],) ,([],)], ['data'])
Review Comment:
For `self-contained`, the data is also repeated once in each example.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-46560][PYTHON][DOCS] Refine docstring `reverse/map_contains_key` [spark]
Posted by "panbingkun (via GitHub)" <gi...@apache.org>.
panbingkun commented on code in PR #44561:
URL: https://github.com/apache/spark/pull/44561#discussion_r1440028260
##########
python/pyspark/sql/functions/builtin.py:
##########
@@ -15313,18 +15313,23 @@ def reverse(col: "ColumnOrName") -> Column:
Parameters
----------
col : :class:`~pyspark.sql.Column` or str
- name of column or expression
+ The name of the column or an expression that represents the element to be reversed.
Returns
-------
:class:`~pyspark.sql.Column`
- array of elements in reverse order.
+ A new column that contains a reversed string or an array with elements in reverse order.
Examples
--------
+ Example 1: Reverse a string
+
Review Comment:
Done
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-46560][PYTHON][DOCS] Refine docstring `reverse/map_contains_key` [spark]
Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon commented on code in PR #44561:
URL: https://github.com/apache/spark/pull/44561#discussion_r1441385542
##########
python/pyspark/sql/functions/builtin.py:
##########
@@ -15427,15 +15443,20 @@ def map_contains_key(col: "ColumnOrName", value: Any) -> Column:
Examples
--------
- >>> from pyspark.sql.functions import map_contains_key
+ Example 1: The key is in the map
+
+ >>> from pyspark.sql import functions as sf
>>> df = spark.sql("SELECT map(1, 'a', 2, 'b') as data")
- >>> df.select(map_contains_key("data", 1)).show()
+ >>> df.select(sf.map_contains_key("data", 1)).show()
+-------------------------+
|map_contains_key(data, 1)|
+-------------------------+
| true|
+-------------------------+
- >>> df.select(map_contains_key("data", -1)).show()
+
+ Example 2: The key is not in the map
+
+ >>> df.select(sf.map_contains_key("data", -1)).show()
Review Comment:
yeah. we have discussed in some other PRs. Should make it self-contained with `from pyspark.sql import functions as sf`.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-46560][PYTHON][DOCS] Refine docstring `reverse/map_contains_key` [spark]
Posted by "LuciferYang (via GitHub)" <gi...@apache.org>.
LuciferYang commented on code in PR #44561:
URL: https://github.com/apache/spark/pull/44561#discussion_r1440096064
##########
python/pyspark/sql/functions/builtin.py:
##########
@@ -15427,15 +15443,20 @@ def map_contains_key(col: "ColumnOrName", value: Any) -> Column:
Examples
--------
- >>> from pyspark.sql.functions import map_contains_key
+ Example 1: The key is in the map
+
+ >>> from pyspark.sql import functions as sf
>>> df = spark.sql("SELECT map(1, 'a', 2, 'b') as data")
- >>> df.select(map_contains_key("data", 1)).show()
+ >>> df.select(sf.map_contains_key("data", 1)).show()
+-------------------------+
|map_contains_key(data, 1)|
+-------------------------+
| true|
+-------------------------+
- >>> df.select(map_contains_key("data", -1)).show()
+
+ Example 2: The key is not in the map
+
+ >>> df.select(sf.map_contains_key("data", -1)).show()
Review Comment:
I prefer to `self-contained`, cc @zhengruifeng
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-46560][PYTHON][DOCS] Refine docstring `reverse/map_contains_key` [spark]
Posted by "dongjoon-hyun (via GitHub)" <gi...@apache.org>.
dongjoon-hyun closed pull request #44561: [SPARK-46560][PYTHON][DOCS] Refine docstring `reverse/map_contains_key`
URL: https://github.com/apache/spark/pull/44561
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-46560][PYTHON][DOCS] Refine docstring `reverse/map_contains_key` [spark]
Posted by "LuciferYang (via GitHub)" <gi...@apache.org>.
LuciferYang commented on code in PR #44561:
URL: https://github.com/apache/spark/pull/44561#discussion_r1439490968
##########
python/pyspark/sql/functions/builtin.py:
##########
@@ -15313,18 +15313,23 @@ def reverse(col: "ColumnOrName") -> Column:
Parameters
----------
col : :class:`~pyspark.sql.Column` or str
- name of column or expression
+ The name of the column or an expression that represents the element to be reversed.
Returns
-------
:class:`~pyspark.sql.Column`
- array of elements in reverse order.
+ A new column that contains a reversed string or an array with elements in reverse order.
Examples
--------
+ Example 1: Reverse a string
+
Review Comment:
Let's standardize the format:
1. import functions as sf and import other necessaries
2. try not to use `.alias`
3. perhaps `show` is clearer than `collect` when displaying results.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-46560][PYTHON][DOCS] Refine docstring `reverse/map_contains_key` [spark]
Posted by "zhengruifeng (via GitHub)" <gi...@apache.org>.
zhengruifeng commented on code in PR #44561:
URL: https://github.com/apache/spark/pull/44561#discussion_r1442419230
##########
python/pyspark/sql/functions/builtin.py:
##########
@@ -15313,21 +15313,39 @@ def reverse(col: "ColumnOrName") -> Column:
Parameters
----------
col : :class:`~pyspark.sql.Column` or str
- name of column or expression
+ The name of the column or an expression that represents the element to be reversed.
Returns
-------
:class:`~pyspark.sql.Column`
- array of elements in reverse order.
+ A new column that contains a reversed string or an array with elements in reverse order.
Examples
--------
+ Example 1: Reverse a string
+
+ >>> import pyspark.sql.functions as sf
>>> df = spark.createDataFrame([('Spark SQL',)], ['data'])
- >>> df.select(reverse(df.data).alias('s')).collect()
- [Row(s='LQS krapS')]
+ >>> df.select(sf.reverse(df.data)).show()
+ +-------------+
+ |reverse(data)|
+ +-------------+
+ | LQS krapS|
+ +-------------+
+
+ Example 2: Reverse an array
+
+ >>> df = spark.createDataFrame([([2, 1, 3],) ,([1],) ,([],)], ['data'])
Review Comment:
I mean here
https://github.com/apache/spark/pull/44561/files?diff=split&w=0#diff-52f85aab7bad664787b9ac7b86cdf1871e2a51bd05059841fcab67b662449095R15339-R15341
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-46560][PYTHON][DOCS] Refine docstring `reverse/map_contains_key` [spark]
Posted by "LuciferYang (via GitHub)" <gi...@apache.org>.
LuciferYang commented on code in PR #44561:
URL: https://github.com/apache/spark/pull/44561#discussion_r1439490968
##########
python/pyspark/sql/functions/builtin.py:
##########
@@ -15313,18 +15313,23 @@ def reverse(col: "ColumnOrName") -> Column:
Parameters
----------
col : :class:`~pyspark.sql.Column` or str
- name of column or expression
+ The name of the column or an expression that represents the element to be reversed.
Returns
-------
:class:`~pyspark.sql.Column`
- array of elements in reverse order.
+ A new column that contains a reversed string or an array with elements in reverse order.
Examples
--------
+ Example 1: Reverse a string
+
Review Comment:
Let's standardize the format:
1. import functions as sf and import other necessaries
2. try not to use `.alias`
3. perhaps `show` is clearer than `collect` when it comes to displaying results.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-46560][PYTHON][DOCS] Refine docstring `reverse/map_contains_key` [spark]
Posted by "dongjoon-hyun (via GitHub)" <gi...@apache.org>.
dongjoon-hyun commented on code in PR #44561:
URL: https://github.com/apache/spark/pull/44561#discussion_r1441386228
##########
python/pyspark/sql/functions/builtin.py:
##########
@@ -15427,15 +15443,20 @@ def map_contains_key(col: "ColumnOrName", value: Any) -> Column:
Examples
--------
- >>> from pyspark.sql.functions import map_contains_key
+ Example 1: The key is in the map
+
+ >>> from pyspark.sql import functions as sf
>>> df = spark.sql("SELECT map(1, 'a', 2, 'b') as data")
- >>> df.select(map_contains_key("data", 1)).show()
+ >>> df.select(sf.map_contains_key("data", 1)).show()
+-------------------------+
|map_contains_key(data, 1)|
+-------------------------+
| true|
+-------------------------+
- >>> df.select(map_contains_key("data", -1)).show()
+
+ Example 2: The key is not in the map
+
+ >>> df.select(sf.map_contains_key("data", -1)).show()
Review Comment:
Thank you for informing us the guidance, @HyukjinKwon . cc @panbingkun
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-46560][PYTHON][DOCS] Refine docstring `reverse/map_contains_key` [spark]
Posted by "LuciferYang (via GitHub)" <gi...@apache.org>.
LuciferYang commented on code in PR #44561:
URL: https://github.com/apache/spark/pull/44561#discussion_r1440078132
##########
python/pyspark/sql/functions/builtin.py:
##########
@@ -15313,21 +15313,37 @@ def reverse(col: "ColumnOrName") -> Column:
Parameters
----------
col : :class:`~pyspark.sql.Column` or str
- name of column or expression
+ The name of the column or an expression that represents the element to be reversed.
Returns
-------
:class:`~pyspark.sql.Column`
- array of elements in reverse order.
+ A new column that contains a reversed string or an array with elements in reverse order.
Examples
--------
+ Example 1: Reverse a string
+
+ >>> import pyspark.sql.functions as sf
>>> df = spark.createDataFrame([('Spark SQL',)], ['data'])
- >>> df.select(reverse(df.data).alias('s')).collect()
- [Row(s='LQS krapS')]
+ >>> df.select(sf.reverse(df.data)).show()
+ +-------------+
+ |reverse(data)|
+ +-------------+
+ | LQS krapS|
+ +-------------+
+
+ Example 2: Reverse an array
+
>>> df = spark.createDataFrame([([2, 1, 3],) ,([1],) ,([],)], ['data'])
- >>> df.select(reverse(df.data).alias('r')).collect()
- [Row(r=[3, 1, 2]), Row(r=[1]), Row(r=[])]
+ >>> df.select(sf.reverse(df.data)).show()
Review Comment:
```suggestion
>>> from pyspark.sql import functions as sf
>>> df = spark.createDataFrame([([2, 1, 3],) ,([1],) ,([],)], ['data'])
>>> df.select(sf.reverse(df.data)).show()
```
##########
python/pyspark/sql/functions/builtin.py:
##########
@@ -15427,15 +15443,20 @@ def map_contains_key(col: "ColumnOrName", value: Any) -> Column:
Examples
--------
- >>> from pyspark.sql.functions import map_contains_key
+ Example 1: The key is in the map
+
+ >>> from pyspark.sql import functions as sf
>>> df = spark.sql("SELECT map(1, 'a', 2, 'b') as data")
- >>> df.select(map_contains_key("data", 1)).show()
+ >>> df.select(sf.map_contains_key("data", 1)).show()
+-------------------------+
|map_contains_key(data, 1)|
+-------------------------+
| true|
+-------------------------+
- >>> df.select(map_contains_key("data", -1)).show()
+
+ Example 2: The key is not in the map
+
+ >>> df.select(sf.map_contains_key("data", -1)).show()
Review Comment:
```suggestion
>>> from pyspark.sql import functions as sf
>>> df = spark.sql("SELECT map(1, 'a', 2, 'b') as data")
>>> df.select(sf.map_contains_key("data", -1)).show()
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-46560][PYTHON][DOCS] Refine docstring `reverse/map_contains_key` [spark]
Posted by "dongjoon-hyun (via GitHub)" <gi...@apache.org>.
dongjoon-hyun commented on code in PR #44561:
URL: https://github.com/apache/spark/pull/44561#discussion_r1441330364
##########
python/pyspark/sql/functions/builtin.py:
##########
@@ -15427,15 +15443,20 @@ def map_contains_key(col: "ColumnOrName", value: Any) -> Column:
Examples
--------
- >>> from pyspark.sql.functions import map_contains_key
+ Example 1: The key is in the map
+
+ >>> from pyspark.sql import functions as sf
>>> df = spark.sql("SELECT map(1, 'a', 2, 'b') as data")
- >>> df.select(map_contains_key("data", 1)).show()
+ >>> df.select(sf.map_contains_key("data", 1)).show()
+-------------------------+
|map_contains_key(data, 1)|
+-------------------------+
| true|
+-------------------------+
- >>> df.select(map_contains_key("data", -1)).show()
+
+ Example 2: The key is not in the map
+
+ >>> df.select(sf.map_contains_key("data", -1)).show()
Review Comment:
cc @HyukjinKwon for the above question about `from pyspark.sql import functions as sf`
> Do we need to make each example self-contained now?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-46560][PYTHON][DOCS] Refine docstring `reverse/map_contains_key` [spark]
Posted by "zhengruifeng (via GitHub)" <gi...@apache.org>.
zhengruifeng commented on code in PR #44561:
URL: https://github.com/apache/spark/pull/44561#discussion_r1442419230
##########
python/pyspark/sql/functions/builtin.py:
##########
@@ -15313,21 +15313,39 @@ def reverse(col: "ColumnOrName") -> Column:
Parameters
----------
col : :class:`~pyspark.sql.Column` or str
- name of column or expression
+ The name of the column or an expression that represents the element to be reversed.
Returns
-------
:class:`~pyspark.sql.Column`
- array of elements in reverse order.
+ A new column that contains a reversed string or an array with elements in reverse order.
Examples
--------
+ Example 1: Reverse a string
+
+ >>> import pyspark.sql.functions as sf
>>> df = spark.createDataFrame([('Spark SQL',)], ['data'])
- >>> df.select(reverse(df.data).alias('s')).collect()
- [Row(s='LQS krapS')]
+ >>> df.select(sf.reverse(df.data)).show()
+ +-------------+
+ |reverse(data)|
+ +-------------+
+ | LQS krapS|
+ +-------------+
+
+ Example 2: Reverse an array
+
+ >>> df = spark.createDataFrame([([2, 1, 3],) ,([1],) ,([],)], ['data'])
Review Comment:
I mean `df` is defined twice in this example
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-46560][PYTHON][DOCS] Refine docstring `reverse/map_contains_key` [spark]
Posted by "zhengruifeng (via GitHub)" <gi...@apache.org>.
zhengruifeng commented on code in PR #44561:
URL: https://github.com/apache/spark/pull/44561#discussion_r1441628705
##########
python/pyspark/sql/functions/builtin.py:
##########
@@ -15313,21 +15313,39 @@ def reverse(col: "ColumnOrName") -> Column:
Parameters
----------
col : :class:`~pyspark.sql.Column` or str
- name of column or expression
+ The name of the column or an expression that represents the element to be reversed.
Returns
-------
:class:`~pyspark.sql.Column`
- array of elements in reverse order.
+ A new column that contains a reversed string or an array with elements in reverse order.
Examples
--------
+ Example 1: Reverse a string
+
+ >>> import pyspark.sql.functions as sf
>>> df = spark.createDataFrame([('Spark SQL',)], ['data'])
- >>> df.select(reverse(df.data).alias('s')).collect()
- [Row(s='LQS krapS')]
+ >>> df.select(sf.reverse(df.data)).show()
+ +-------------+
+ |reverse(data)|
+ +-------------+
+ | LQS krapS|
+ +-------------+
+
+ Example 2: Reverse an array
+
+ >>> df = spark.createDataFrame([([2, 1, 3],) ,([1],) ,([],)], ['data'])
Review Comment:
nit, is this line duplicated?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-46560][PYTHON][DOCS] Refine docstring `reverse/map_contains_key` [spark]
Posted by "panbingkun (via GitHub)" <gi...@apache.org>.
panbingkun commented on code in PR #44561:
URL: https://github.com/apache/spark/pull/44561#discussion_r1440099158
##########
python/pyspark/sql/functions/builtin.py:
##########
@@ -15427,15 +15443,20 @@ def map_contains_key(col: "ColumnOrName", value: Any) -> Column:
Examples
--------
- >>> from pyspark.sql.functions import map_contains_key
+ Example 1: The key is in the map
+
+ >>> from pyspark.sql import functions as sf
>>> df = spark.sql("SELECT map(1, 'a', 2, 'b') as data")
- >>> df.select(map_contains_key("data", 1)).show()
+ >>> df.select(sf.map_contains_key("data", 1)).show()
+-------------------------+
|map_contains_key(data, 1)|
+-------------------------+
| true|
+-------------------------+
- >>> df.select(map_contains_key("data", -1)).show()
+
+ Example 2: The key is not in the map
+
+ >>> df.select(sf.map_contains_key("data", -1)).show()
Review Comment:
Actually, I can do it all, but I think it's best for us to have `a stable rule`.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org