nchammas commented on PR #44971:
URL: https://github.com/apache/spark/pull/44971#issuecomment-1930079352
> I'd like to keep the option open for hand crafted long-form error docs.
Any thoughts?
I'm fine with that. If we find in the future that some error condition
merits a dedicated page, then what I suggest we do is the following:
- Create a hand-crafted error page with the extended prose we want.
- Add a link from the error condition's message in the JSON document to that
standalone page.
We should express that link using Markdown. `build-error-docs.py`
[compiles any Markdown in the message][1] into clean HTML.
[1]:
https://github.com/apache/spark/pull/44971/files#diff-b957f1b0f8f56d693a8b175c6068e361b3f3e4a5ba5b971604702f9adfe5df85R24
The result will be a nice HTML link from the description of the error
condition in the master table to whatever error page we need.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
