Skip to content

Conversation

@panbingkun
Copy link
Contributor

@panbingkun panbingkun commented Apr 17, 2024

What changes were proposed in this pull request?

The pr is following up #44902, to make some reference files links clickable.

Why are the changes needed?

Convenient for developers to navigate directly when read this file README.md.

Does this PR introduce any user-facing change?

No.

How was this patch tested?

Manually test.

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

No.

@github-actions github-actions bot added the DOCS label Apr 17, 2024
@panbingkun panbingkun changed the title [SPARK-46810][DOCS][FOLLOWUP] Make file links clickable [SPARK-46810][DOCS][FOLLOWUP] Make some reference file links clickable Apr 17, 2024

Fixing this will require renaming `SparkException.errorClass` to `SparkException.errorCondition` and making similar changes to `ErrorClassesJsonReader` and other parts of the codebase. We will address this in [SPARK-47429]. Until that is complete, we will have to live with the fact that a string like `DATATYPE_MISSING_SIZE` is called an "error condition" in our user-facing documentation but an "error class" in the code.

For more details, please see [SPARK-46810][SPARK-46810].
Copy link
Contributor Author

Choose a reason for hiding this comment

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

After remove last [SPARK-46810], we can still click on it.
image

Copy link
Contributor

Choose a reason for hiding this comment

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

Oh, interesting.

@panbingkun
Copy link
Contributor Author

Before:
image

After:
image

@panbingkun
Copy link
Contributor Author

cc @nchammas @cloud-fan @MaxGekk


Fixing this will require renaming `SparkException.errorClass` to `SparkException.errorCondition` and making similar changes to `ErrorClassesJsonReader` and other parts of the codebase. We will address this in [SPARK-47429]. Until that is complete, we will have to live with the fact that a string like `DATATYPE_MISSING_SIZE` is called an "error condition" in our user-facing documentation but an "error class" in the code.

For more details, please see [SPARK-46810][SPARK-46810].
Copy link
Contributor

Choose a reason for hiding this comment

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

Oh, interesting.

@panbingkun
Copy link
Contributor Author

also cc @dongjoon-hyun @HyukjinKwon

@HyukjinKwon
Copy link
Member

Merged to master.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants