Skip to content

[SPARK-46259][PYTHON][DOCS] Add an appropriate link for error class usage documentation. #44175

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
itholic wants to merge 5 commits into from
Closed

[SPARK-46259][PYTHON][DOCS] Add an appropriate link for error class usage documentation. #44175

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6f9adf9
[SPARK-46259][PYTHON][DOCS] Add appropriate link for error class usag…
itholic Dec 5, 2023
5db5be4
Retrigger CI
itholic Dec 5, 2023
5fe045c
Retrigger CI
itholic Dec 5, 2023
f844f3b
Retrigger again
itholic Dec 5, 2023
cb1fc9d
Merge branch 'master' of https://github.com/apache/spark into add_err…
itholic Dec 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions python/docs/source/development/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -246,9 +246,9 @@ To throw a standardized user-facing error or exception, developers should specif
Usage
~~~~~

1. Check if an appropriate error class already exists in `error_classes.py`.
1. Check if an appropriate error class already exists in `Error classes in PySpark <errors.rst#error-classes-in-pyspark>`_.
If true, use the error class and skip to step 3.
2. Add a new class to `error_classes.py`; keep in mind the invariants below.
2. Add a new class to `error_classes.py <https://github.com/apache/spark/blob/master/python/pyspark/errors/error_classes.py>`_; keep in mind the invariants below.
3. Check if the exception type already extends `PySparkException`.
If true, skip to step 5.
4. Mix `PySparkException` into the exception.
Expand Down