You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@spark.apache.org by "HyukjinKwon (via GitHub)" <gi...@apache.org> on 2023/08/22 06:40:36 UTC

[GitHub] [spark] HyukjinKwon opened a new pull request, #42602: [MINOR][PYTHON][DOCS] Remove duplicated versionchanged per versionadded

HyukjinKwon opened a new pull request, #42602:
URL: https://github.com/apache/spark/pull/42602

   ### What changes were proposed in this pull request?
   
   This PR addresses all the cases of duplicated `versionchanged` directives with `versionadded` directives, see also https://github.com/apache/spark/pull/42597.
   
   ### Why are the changes needed?
   
   To remove duplicated information in docstring.
   
   ### Does this PR introduce _any_ user-facing change?
   
   Yes, it removes duplicated information in PySpark API Reference page.
   
   ### How was this patch tested?
   
   CI in this PR should validate them.
   
   ### Was this patch authored or co-authored using generative AI tooling?
   No.


-- 
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


[GitHub] [spark] HyukjinKwon commented on a diff in pull request #42602: [MINOR][PYTHON][DOCS] Remove duplicated versionchanged per versionadded

Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon commented on code in PR #42602:
URL: https://github.com/apache/spark/pull/42602#discussion_r1301140781


##########
python/pyspark/sql/conf.py:
##########
@@ -66,11 +59,7 @@ def get(
 
     @since(2.0)
     def unset(self, key: str) -> None:
-        """Resets the configuration property for the given key.
-
-        .. versionchanged:: 3.4.0
-            Supports Spark Connect.
-        """
+        """Resets the configuration property for the given key."""

Review Comment:
   Lol let's fix it since we're here.



-- 
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


[GitHub] [spark] yaooqinn commented on a diff in pull request #42602: [MINOR][PYTHON][DOCS] Remove duplicated versionchanged per versionadded

Posted by "yaooqinn (via GitHub)" <gi...@apache.org>.
yaooqinn commented on code in PR #42602:
URL: https://github.com/apache/spark/pull/42602#discussion_r1301148804


##########
python/pyspark/sql/conf.py:
##########
@@ -66,11 +59,7 @@ def get(
 
     @since(2.0)
     def unset(self, key: str) -> None:
-        """Resets the configuration property for the given key.
-
-        .. versionchanged:: 3.4.0
-            Supports Spark Connect.
-        """
+        """Resets the configuration property for the given key."""

Review Comment:
   Yes, I am okay with it.



-- 
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


[GitHub] [spark] HyukjinKwon commented on pull request #42602: [MINOR][PYTHON][DOCS] Remove duplicated versionchanged per versionadded

Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon commented on PR #42602:
URL: https://github.com/apache/spark/pull/42602#issuecomment-1687557078

   cc @LuciferYang @yaooqinn @zhengruifeng FYI


-- 
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


[GitHub] [spark] HyukjinKwon commented on a diff in pull request #42602: [MINOR][PYTHON][DOCS] Remove duplicated versionchanged per versionadded

Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon commented on code in PR #42602:
URL: https://github.com/apache/spark/pull/42602#discussion_r1301143091


##########
python/pyspark/sql/conf.py:
##########
@@ -66,11 +59,7 @@ def get(
 
     @since(2.0)
     def unset(self, key: str) -> None:
-        """Resets the configuration property for the given key.
-
-        .. versionchanged:: 3.4.0
-            Supports Spark Connect.
-        """
+        """Resets the configuration property for the given key."""

Review Comment:
   Actually, I think it's fine. It will reset it to its default value .. in a way :-).



-- 
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


[GitHub] [spark] yaooqinn commented on a diff in pull request #42602: [MINOR][PYTHON][DOCS] Remove duplicated versionchanged per versionadded

Posted by "yaooqinn (via GitHub)" <gi...@apache.org>.
yaooqinn commented on code in PR #42602:
URL: https://github.com/apache/spark/pull/42602#discussion_r1301126004


##########
python/pyspark/sql/conf.py:
##########
@@ -66,11 +59,7 @@ def get(
 
     @since(2.0)
     def unset(self, key: str) -> None:
-        """Resets the configuration property for the given key.
-
-        .. versionchanged:: 3.4.0
-            Supports Spark Connect.
-        """
+        """Resets the configuration property for the given key."""

Review Comment:
   This comment is not related to the current PR. However, I have a question about the accuracy of this document. Unsets?



-- 
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


[GitHub] [spark] HyukjinKwon commented on a diff in pull request #42602: [MINOR][PYTHON][DOCS] Remove duplicated versionchanged per versionadded

Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon commented on code in PR #42602:
URL: https://github.com/apache/spark/pull/42602#discussion_r1301143791


##########
python/pyspark/sql/conf.py:
##########
@@ -66,11 +59,7 @@ def get(
 
     @since(2.0)
     def unset(self, key: str) -> None:
-        """Resets the configuration property for the given key.
-
-        .. versionchanged:: 3.4.0
-            Supports Spark Connect.
-        """
+        """Resets the configuration property for the given key."""

Review Comment:
   Scala side has the same doc so let's leave it here for 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


[GitHub] [spark] HyukjinKwon commented on a diff in pull request #42602: [MINOR][PYTHON][DOCS] Remove duplicated versionchanged per versionadded

Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon commented on code in PR #42602:
URL: https://github.com/apache/spark/pull/42602#discussion_r1301140781


##########
python/pyspark/sql/conf.py:
##########
@@ -66,11 +59,7 @@ def get(
 
     @since(2.0)
     def unset(self, key: str) -> None:
-        """Resets the configuration property for the given key.
-
-        .. versionchanged:: 3.4.0
-            Supports Spark Connect.
-        """
+        """Resets the configuration property for the given key."""

Review Comment:
   Lol let's fix it since we're here.



-- 
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


[GitHub] [spark] HyukjinKwon commented on a diff in pull request #42602: [MINOR][PYTHON][DOCS] Remove duplicated versionchanged per versionadded

Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon commented on code in PR #42602:
URL: https://github.com/apache/spark/pull/42602#discussion_r1301102457


##########
python/pyspark/sql/functions.py:
##########
@@ -626,6 +623,10 @@ def mode(col: "ColumnOrName") -> Column:
     :class:`~pyspark.sql.Column`
         the most frequent value in a group.
 
+    Notes

Review Comment:
   That's a good point..



-- 
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


[GitHub] [spark] HyukjinKwon commented on pull request #42602: [MINOR][PYTHON][DOCS] Remove duplicated versionchanged per versionadded

Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon commented on PR #42602:
URL: https://github.com/apache/spark/pull/42602#issuecomment-1687979503

   Merged to master and branch-3.5.


-- 
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


[GitHub] [spark] HyukjinKwon commented on a diff in pull request #42602: [MINOR][PYTHON][DOCS] Remove duplicated versionchanged per versionadded

Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon commented on code in PR #42602:
URL: https://github.com/apache/spark/pull/42602#discussion_r1301082793


##########
python/pyspark/sql/conf.py:
##########
@@ -39,11 +39,7 @@ def __init__(self, jconf: JavaObject) -> None:
 
     @since(2.0)
     def set(self, key: str, value: Union[str, int, bool]) -> None:
-        """Sets the given Spark runtime configuration property.
-
-        .. versionchanged:: 3.4.0

Review Comment:
   ` .. versionchanged:: 3.4.0` is mentioned at the class level above.



-- 
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


[GitHub] [spark] zhengruifeng commented on a diff in pull request #42602: [MINOR][PYTHON][DOCS] Remove duplicated versionchanged per versionadded

Posted by "zhengruifeng (via GitHub)" <gi...@apache.org>.
zhengruifeng commented on code in PR #42602:
URL: https://github.com/apache/spark/pull/42602#discussion_r1301090749


##########
python/pyspark/sql/functions.py:
##########
@@ -626,6 +623,10 @@ def mode(col: "ColumnOrName") -> Column:
     :class:`~pyspark.sql.Column`
         the most frequent value in a group.
 
+    Notes

Review Comment:
   I am fine with this `Notes`
   
   but does it means all the 150+ functions added in 3.5.0 needs this?



-- 
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


[GitHub] [spark] HyukjinKwon closed pull request #42602: [MINOR][PYTHON][DOCS] Remove duplicated versionchanged per versionadded

Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon closed pull request #42602: [MINOR][PYTHON][DOCS] Remove duplicated versionchanged per versionadded
URL: https://github.com/apache/spark/pull/42602


-- 
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