You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@spark.apache.org by "nchammas (via GitHub)" <gi...@apache.org> on 2026/07/25 04:13:31 UTC
[PR] [SPARK-58348][PYTHON][DOCS] Move PySpark error doc header into global variable [spark]
nchammas opened a new pull request, #57523:
URL: https://github.com/apache/spark/pull/57523
### What changes were proposed in this pull request?
Move the PySpark error doc header into a global variable and reformat very long lines.
Tweak the wording of the heading about PySpark errors and exceptions.
### Why are the changes needed?
The lengthy error doc header immediately follows a lengthy method docstring, leading to a visually confusing mix of indentation levels and multiline strings. Splitting it up just makes things visually easier to follow.
The wording change of the heading is so it reads more naturally.
### Does this PR introduce _any_ user-facing change?
Documentation only.
### How was this patch tested?
I built and reviewed the PySpark error docs locally.
```sh
cd python/docs
make html
open build/html/development/errors.html
```
### 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
Re: [PR] [SPARK-58348][PYTHON][DOCS] Move PySpark error doc header into global variable [spark]
Posted by "uros-b (via GitHub)" <gi...@apache.org>.
uros-b commented on PR #57523:
URL: https://github.com/apache/spark/pull/57523#issuecomment-5159512020
**Merge Summary:**
- merged into master https://github.com/apache/spark/commit/d5b467e760598f4c99c1f7ff326c3e0b1e476c17
- merged into branch-4.x https://github.com/apache/spark/commit/5624c4c6bb3d43c649f6b05bdd850d0f052d8106
*Posted by `merge_spark_pr.py`*
--
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-58348][PYTHON][DOCS] Move PySpark error doc header into global variable [spark]
Posted by "nchammas (via GitHub)" <gi...@apache.org>.
nchammas commented on PR #57523:
URL: https://github.com/apache/spark/pull/57523#issuecomment-5079098482
cc @itholic
--
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-58348][PYTHON][DOCS] Move PySpark error doc header into global variable [spark]
Posted by "nchammas (via GitHub)" <gi...@apache.org>.
nchammas commented on code in PR #57523:
URL: https://github.com/apache/spark/pull/57523#discussion_r3649389430
##########
python/pyspark/errors_doc_gen.py:
##########
@@ -41,12 +23,34 @@ def generate_errors_doc(output_rst_file_path: str) -> None:
Error classes in PySpark
========================
-This is a list of common, named error classes returned by PySpark which are defined at `error-conditions.json <https://github.com/apache/spark/blob/master/python/pyspark/errors/error-conditions.json>`_.
+This is a list of common, named error classes returned by PySpark which are defined at
+`error-conditions.json <https://github.com/apache/spark/blob/master/python/pyspark/errors/error-conditions.json>`_.
-When writing PySpark errors, developers must use an error class from the list. If an appropriate error class is not available, add a new one into the list. For more information, please refer to `Contributing Error and Exception <contributing.rst#contributing-error-and-exception>`_.
Review Comment:
I'm surprised our Python linter allowed long lines like 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
Re: [PR] [SPARK-58348][PYTHON][DOCS] Move PySpark error doc header into global variable [spark]
Posted by "uros-b (via GitHub)" <gi...@apache.org>.
uros-b closed pull request #57523: [SPARK-58348][PYTHON][DOCS] Move PySpark error doc header into global variable
URL: https://github.com/apache/spark/pull/57523
--
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-58348][PYTHON][DOCS] Move PySpark error doc header into global variable [spark]
Posted by "uros-b (via GitHub)" <gi...@apache.org>.
uros-b commented on PR #57523:
URL: https://github.com/apache/spark/pull/57523#issuecomment-5083084714
LGTM
--
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