-
Notifications
You must be signed in to change notification settings - Fork 29k
[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.
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
Conversation
|
I have no idea what happened to |
dongjoon-hyun
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+1, LGTM.
|
FYI, since Apache Spark 3.0.0, we don't allow So, if you don't mind, please don't add |
|
Merged to master. Thank you, @itholic . |
Oh, I see. Thanks for the notice! |
…sage documentation ### What changes were proposed in this pull request? This PR proposes to add appropriate link for error class usage documentation. ### Why are the changes needed? The current [Usage of Contributing Error and Exception documentation](https://spark.apache.org/docs/latest/api/python/development/contributing.html#usage) is lack of information where users exactly can search the existing error classes, and also where users can add a new error classes. We should add an appropriate link to make the documentation clearer. ### Does this PR introduce _any_ user-facing change? No API changes, but this improves the usability of error class usage documentation: **Before** <img width="724" alt="Screenshot 2023-12-05 at 12 25 32 PM" src="https://github.com/apache/spark/assets/44108233/df9f80e2-2f99-413c-aca2-0e8634440a46"> **After** <img width="712" alt="Screenshot 2023-12-05 at 12 24 25 PM" src="https://github.com/apache/spark/assets/44108233/bba6d43f-bf85-4e3b-86ea-df9bad4634a6"> ### How was this patch tested? Manually build docs and confirm. ### Was this patch authored or co-authored using generative AI tooling? No. Closes apache#44175 from itholic/add_error_class_link. Authored-by: Haejoon Lee <haejoon.lee@databricks.com> Signed-off-by: Dongjoon Hyun <dhyun@apple.com>
What changes were proposed in this pull request?
This PR proposes to add appropriate link for error class usage documentation.
Why are the changes needed?
The current Usage of Contributing Error and Exception documentation is lack of information where users exactly can search the existing error classes, and also where users can add a new error classes. We should add an appropriate link to make the documentation clearer.
Does this PR introduce any user-facing change?
No API changes, but this improves the usability of error class usage documentation:
Before
After

How was this patch tested?
Manually build docs and confirm.
Was this patch authored or co-authored using generative AI tooling?
No.