You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@spark.apache.org by GitBox <gi...@apache.org> on 2021/07/20 12:26:46 UTC

[GitHub] [spark] dominikgehl opened a new pull request #33440: [SPARK-36226] improve python docstring links to other classes

dominikgehl opened a new pull request #33440:
URL: https://github.com/apache/spark/pull/33440


   
   ### What changes were proposed in this pull request?
   additional links to other classes in python documentation
   
   
   ### Why are the changes needed?
   python docstring syntax wasn't fully used everywhere
   
   
   ### Does this PR introduce _any_ user-facing change?
   No
   
   
   ### How was this patch tested?
   Documentation change only
   


-- 
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 change in pull request #33440: [SPARK-36226][PYTHON][DOCS] Improve python docstring links to other classes

Posted by GitBox <gi...@apache.org>.
HyukjinKwon commented on a change in pull request #33440:
URL: https://github.com/apache/spark/pull/33440#discussion_r673124222



##########
File path: python/pyspark/sql/session.py
##########
@@ -73,7 +73,7 @@ class SparkSession(SparkConversionMixin):
 
     A SparkSession can be used create :class:`DataFrame`, register :class:`DataFrame` as
     tables, execute SQL over tables, cache tables, and read parquet files.
-    To create a SparkSession, use the following builder pattern:
+    To create a :class:`SparkSession`, use the following builder pattern:

Review comment:
       If these are all of them, I think it's good to go.




-- 
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] AmplabJenkins commented on pull request #33440: [SPARK-36226] improve python docstring links to other classes

Posted by GitBox <gi...@apache.org>.
AmplabJenkins commented on pull request #33440:
URL: https://github.com/apache/spark/pull/33440#issuecomment-883368556


   
   Refer to this link for build results (access rights to CI server needed): 
   https://amplab.cs.berkeley.edu/jenkins//job/SparkPullRequestBuilder/141332/
   


-- 
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 change in pull request #33440: [SPARK-36226][PYTHON][DOCS] Improve python docstring links to other classes

Posted by GitBox <gi...@apache.org>.
HyukjinKwon commented on a change in pull request #33440:
URL: https://github.com/apache/spark/pull/33440#discussion_r673109356



##########
File path: python/pyspark/sql/session.py
##########
@@ -73,7 +73,7 @@ class SparkSession(SparkConversionMixin):
 
     A SparkSession can be used create :class:`DataFrame`, register :class:`DataFrame` as
     tables, execute SQL over tables, cache tables, and read parquet files.
-    To create a SparkSession, use the following builder pattern:
+    To create a :class:`SparkSession`, use the following builder pattern:

Review comment:
       Yeah, I agree.




-- 
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] SparkQA commented on pull request #33440: [SPARK-36226] improve python docstring links to other classes

Posted by GitBox <gi...@apache.org>.
SparkQA commented on pull request #33440:
URL: https://github.com/apache/spark/pull/33440#issuecomment-883356253


   **[Test build #141332 has finished](https://amplab.cs.berkeley.edu/jenkins/job/SparkPullRequestBuilder/141332/testReport)** for PR 33440 at commit [`7bcb8e7`](https://github.com/apache/spark/commit/7bcb8e7e90ba3cf4f239fb48113bd5d3eb803a86).
    * This patch passes all tests.
    * This patch merges cleanly.
    * This patch adds no public classes.


-- 
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 #33440: [SPARK-36226][PYTHON][DOCS] Improve python docstring links to other classes

Posted by GitBox <gi...@apache.org>.
HyukjinKwon commented on pull request #33440:
URL: https://github.com/apache/spark/pull/33440#issuecomment-885541712


   Merged to master, branch-3.2 and branch-3.1.


-- 
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] SparkQA removed a comment on pull request #33440: [SPARK-36226] improve python docstring links to other classes

Posted by GitBox <gi...@apache.org>.
SparkQA removed a comment on pull request #33440:
URL: https://github.com/apache/spark/pull/33440#issuecomment-883339070


   **[Test build #141332 has started](https://amplab.cs.berkeley.edu/jenkins/job/SparkPullRequestBuilder/141332/testReport)** for PR 33440 at commit [`7bcb8e7`](https://github.com/apache/spark/commit/7bcb8e7e90ba3cf4f239fb48113bd5d3eb803a86).


-- 
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 change in pull request #33440: [SPARK-36226][PYTHON][DOCS] Improve python docstring links to other classes

Posted by GitBox <gi...@apache.org>.
HyukjinKwon commented on a change in pull request #33440:
URL: https://github.com/apache/spark/pull/33440#discussion_r673108737



##########
File path: python/pyspark/sql/group.py
##########
@@ -238,7 +238,7 @@ def pivot(self, pivot_col, values=None):
         ----------
         pivot_col : str
             Name of the column to pivot.
-        values :
+        values : list, optional

Review comment:
       Yeah, it's from https://numpydoc.readthedocs.io/en/latest/format.html. I think it's fine.




-- 
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] SparkQA commented on pull request #33440: [SPARK-36226] improve python docstring links to other classes

Posted by GitBox <gi...@apache.org>.
SparkQA commented on pull request #33440:
URL: https://github.com/apache/spark/pull/33440#issuecomment-883339070


   **[Test build #141332 has started](https://amplab.cs.berkeley.edu/jenkins/job/SparkPullRequestBuilder/141332/testReport)** for PR 33440 at commit [`7bcb8e7`](https://github.com/apache/spark/commit/7bcb8e7e90ba3cf4f239fb48113bd5d3eb803a86).


-- 
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 change in pull request #33440: [SPARK-36226][PYTHON][DOCS] Improve python docstring links to other classes

Posted by GitBox <gi...@apache.org>.
HyukjinKwon commented on a change in pull request #33440:
URL: https://github.com/apache/spark/pull/33440#discussion_r673109037



##########
File path: python/pyspark/sql/group.py
##########
@@ -238,7 +238,7 @@ def pivot(self, pivot_col, values=None):
         ----------
         pivot_col : str
             Name of the column to pivot.
-        values :
+        values : list, optional

Review comment:
       I would do it in batch though.




-- 
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] SparkQA commented on pull request #33440: [SPARK-36226][PYTHON][DOCS] Improve python docstring links to other classes

Posted by GitBox <gi...@apache.org>.
SparkQA commented on pull request #33440:
URL: https://github.com/apache/spark/pull/33440#issuecomment-883406029


   Kubernetes integration test starting
   URL: https://amplab.cs.berkeley.edu/jenkins/job/SparkPullRequestBuilder-K8s/45847/
   


-- 
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] AmplabJenkins removed a comment on pull request #33440: [SPARK-36226] improve python docstring links to other classes

Posted by GitBox <gi...@apache.org>.
AmplabJenkins removed a comment on pull request #33440:
URL: https://github.com/apache/spark/pull/33440#issuecomment-883368556


   
   Refer to this link for build results (access rights to CI server needed): 
   https://amplab.cs.berkeley.edu/jenkins//job/SparkPullRequestBuilder/141332/
   


-- 
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] dominikgehl commented on a change in pull request #33440: [SPARK-36226][PYTHON][DOCS] Improve python docstring links to other classes

Posted by GitBox <gi...@apache.org>.
dominikgehl commented on a change in pull request #33440:
URL: https://github.com/apache/spark/pull/33440#discussion_r673122267



##########
File path: python/pyspark/sql/session.py
##########
@@ -73,7 +73,7 @@ class SparkSession(SparkConversionMixin):
 
     A SparkSession can be used create :class:`DataFrame`, register :class:`DataFrame` as
     tables, execute SQL over tables, cache tables, and read parquet files.
-    To create a SparkSession, use the following builder pattern:
+    To create a :class:`SparkSession`, use the following builder pattern:

Review comment:
       It seems to be already done in most classes below sql .. these were just a couple of exceptions I noticed




-- 
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] AmplabJenkins removed a comment on pull request #33440: [SPARK-36226][PYTHON][DOCS] Improve python docstring links to other classes

Posted by GitBox <gi...@apache.org>.
AmplabJenkins removed a comment on pull request #33440:
URL: https://github.com/apache/spark/pull/33440#issuecomment-883458706


   
   Refer to this link for build results (access rights to CI server needed): 
   https://amplab.cs.berkeley.edu/jenkins//job/SparkPullRequestBuilder-K8s/45847/
   


-- 
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] srowen commented on a change in pull request #33440: [SPARK-36226] improve python docstring links to other classes

Posted by GitBox <gi...@apache.org>.
srowen commented on a change in pull request #33440:
URL: https://github.com/apache/spark/pull/33440#discussion_r673103150



##########
File path: python/pyspark/sql/session.py
##########
@@ -73,7 +73,7 @@ class SparkSession(SparkConversionMixin):
 
     A SparkSession can be used create :class:`DataFrame`, register :class:`DataFrame` as
     tables, execute SQL over tables, cache tables, and read parquet files.
-    To create a SparkSession, use the following builder pattern:
+    To create a :class:`SparkSession`, use the following builder pattern:

Review comment:
       This is fine, but do we do it consistently? if that would be a big change, I wonder how much it's worth it

##########
File path: python/pyspark/sql/group.py
##########
@@ -238,7 +238,7 @@ def pivot(self, pivot_col, values=None):
         ----------
         pivot_col : str
             Name of the column to pivot.
-        values :
+        values : list, optional

Review comment:
       Do we use this convention anywhere else?




-- 
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] SparkQA commented on pull request #33440: [SPARK-36226][PYTHON][DOCS] Improve python docstring links to other classes

Posted by GitBox <gi...@apache.org>.
SparkQA commented on pull request #33440:
URL: https://github.com/apache/spark/pull/33440#issuecomment-883434787


   Kubernetes integration test status success
   URL: https://amplab.cs.berkeley.edu/jenkins/job/SparkPullRequestBuilder-K8s/45847/
   


-- 
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] AmplabJenkins commented on pull request #33440: [SPARK-36226][PYTHON][DOCS] Improve python docstring links to other classes

Posted by GitBox <gi...@apache.org>.
AmplabJenkins commented on pull request #33440:
URL: https://github.com/apache/spark/pull/33440#issuecomment-883458706


   
   Refer to this link for build results (access rights to CI server needed): 
   https://amplab.cs.berkeley.edu/jenkins//job/SparkPullRequestBuilder-K8s/45847/
   


-- 
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 #33440: [SPARK-36226][PYTHON][DOCS] Improve python docstring links to other classes

Posted by GitBox <gi...@apache.org>.
HyukjinKwon closed pull request #33440:
URL: https://github.com/apache/spark/pull/33440


   


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