Skip to content

Conversation

@itholic
Copy link
Contributor

@itholic itholic commented Dec 5, 2023

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

Screenshot 2023-12-05 at 12 25 32 PM

After
Screenshot 2023-12-05 at 12 24 25 PM

How was this patch tested?

Manually build docs and confirm.

Was this patch authored or co-authored using generative AI tooling?

No.

@itholic
Copy link
Contributor Author

itholic commented Dec 5, 2023

I have no idea what happened to continuous-integration/appveyor/pr, since I couldn't catch any clue for the current failure.
Let me just re-trigger the CI again.

Copy link
Member

@dongjoon-hyun dongjoon-hyun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1, LGTM.

@dongjoon-hyun
Copy link
Member

FYI, since Apache Spark 3.0.0, we don't allow . at the end of the PR title.

So, if you don't mind, please don't add . at the end of the PR title. Although the PR merge script is designed to be clean up like the following, it adds another extra step to the committers. 😄

$ dev/merge_spark_pr.py
git rev-parse --abbrev-ref HEAD
Which pull request would you like to merge? (e.g. 34): 44175
I've re-written the title as follows to match the standard format:
Original: [SPARK-46259][PYTHON][DOCS] Add an appropriate link for error class usage documentation.
Modified: [SPARK-46259][PYTHON][DOCS] Add an appropriate link for error class usage documentation

@dongjoon-hyun
Copy link
Member

Merged to master. Thank you, @itholic .

@itholic
Copy link
Contributor Author

itholic commented Dec 6, 2023

So, if you don't mind, please don't add . at the end of the PR title

Oh, I see. Thanks for the notice!

dbatomic pushed a commit to dbatomic/spark that referenced this pull request Dec 11, 2023
…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>
@itholic itholic deleted the add_error_class_link branch January 1, 2024 23:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants