Link to troubleshooting guide from exception messages#2357
Merged
eamonnmcmanus merged 5 commits intogoogle:masterfrom Apr 15, 2023
Merged
Conversation
Contributor
Author
|
Or maybe instead of the anchors Edit: Have changed this now; feedback regarding the anchor names is appreciated! |
Member
|
This looks great! I'm sure it will be very helpful for users. |
eamonnmcmanus
approved these changes
Apr 9, 2023
Contributor
Author
Or could you please merge it now already? My intention was to avoid conflicts for #2323, however it looks like that has already conflicts with |
eamonnmcmanus
pushed a commit
that referenced
this pull request
May 31, 2023
* Link to troubleshooting guide from exception messages * Add examples to troubleshooting guide * Use proper anchor names for troubleshooting guide
tibor-universe
pushed a commit
to getuniverse/gson
that referenced
this pull request
Sep 14, 2024
* Link to troubleshooting guide from exception messages * Add examples to troubleshooting guide * Use proper anchor names for troubleshooting guide
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose
Adds troubleshooting guide links to some exception messages; improves unit tests
Description
As shortly discussed in #1219 (comment) (
TypeTokenvalidation is not implemented here though) adding troubleshooting guide links to exception messages hopefully makes it easier for users to understand what the exception means and how to solve the issue.This approach again uses custom HTML anchors in a Markdown document even though we had bad experience with this before (#2286), but it appears using only lowercase IDs is supported by GitHub (though possibly not officially, see open question https://github.com/orgs/community/discussions/50962). The custom HTML anchors allow us to produce short stable links.
Open questions:
MalformedJsonExceptions it refers to the troubleshooting guide; maybe we should reduce this only to specific variants?Checklist
null@since $next-version$(
$next-version$is a special placeholder which is automatically replaced during release)TestCase)mvn clean verify javadoc:jarpasses without errors