This is an automated email from the ASF dual-hosted git repository.
gurwls223 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/spark.git
The following commit(s) were added to refs/heads/master by this push:
new 2e81f9a3b561 [SPARK-46810][DOCS][FOLLOWUP] Make some reference file
links clickable
2e81f9a3b561 is described below
commit 2e81f9a3b56107a171249e5ad898e76156f84f0f
Author: panbingkun <panbing...@baidu.com>
AuthorDate: Thu Apr 18 10:09:18 2024 +0900
[SPARK-46810][DOCS][FOLLOWUP] Make some reference file links clickable
### What changes were proposed in this pull request?
The pr is following up https://github.com/apache/spark/pull/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.
Closes #46105 from panbingkun/SPARK-46810_FOLLOWUP.
Authored-by: panbingkun <panbing...@baidu.com>
Signed-off-by: Hyukjin Kwon <gurwls...@apache.org>
---
common/utils/src/main/resources/error/README.md | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)
diff --git a/common/utils/src/main/resources/error/README.md
b/common/utils/src/main/resources/error/README.md
index e2f68a1af9f4..adb631ccdca7 100644
--- a/common/utils/src/main/resources/error/README.md
+++ b/common/utils/src/main/resources/error/README.md
@@ -16,9 +16,9 @@ The error state / SQLSTATE itself is comprised of two parts:
2. Error sub-class
Acceptable values for these various error parts are defined in the following
files:
-* `error-classes.json`
-* `error-states.json`
-* `error-conditions.json`
+* [`error-classes.json`](error-classes.json)
+* [`error-states.json`](error-states.json)
+* [`error-conditions.json`](error-conditions.json)
The terms error class, state, and condition come from the SQL standard.
@@ -41,7 +41,7 @@ Unfortunately, we have historically used the term "error
class" inconsistently t
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].
+For more details, please see [SPARK-46810].
[SPARK-46810]: https://issues.apache.org/jira/browse/SPARK-46810
[SPARK-47429]: https://issues.apache.org/jira/browse/SPARK-47429
@@ -51,9 +51,9 @@ For more details, please see [SPARK-46810][SPARK-46810].
1. Check if the error is an internal error.
Internal errors are bugs in the code that we do not expect users to
encounter; this does not include unsupported operations.
If true, use the error condition `INTERNAL_ERROR` and skip to step 4.
-2. Check if an appropriate error condition already exists in
`error-conditions.json`.
+2. Check if an appropriate error condition already exists in
[`error-conditions.json`](error-conditions.json).
If true, use the error condition and skip to step 4.
-3. Add a new condition to `error-conditions.json`. If the new condition
requires a new error state, add the new error state to `error-states.json`.
+3. Add a new condition to [`error-conditions.json`](error-conditions.json). If
the new condition requires a new error state, add the new error state to
[`error-states.json`](error-states.json).
4. Check if the exception type already extends `SparkThrowable`.
If true, skip to step 6.
5. Mix `SparkThrowable` into the exception.
@@ -165,7 +165,7 @@ For example: The existing `XXKD0` is used for an internal
analyzer error.
#### ANSI/ISO standard
-The SQLSTATEs in `error-states.json` are collated from:
+The SQLSTATEs in [`error-states.json`](error-states.json) are collated from:
- SQL2016
- DB2 zOS/LUW
- PostgreSQL 15
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@spark.apache.org
For additional commands, e-mail: commits-h...@spark.apache.org
