Scaladoc: fix issues with incorrect external links and special characters #14516
Conversation
This file contains 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
Unit tests for links with "#" character were also added.
pikinier20
suggested changes
Feb 21, 2022
jchyb
force-pushed
the
scaladoc/fix-i14505-i14504
branch
2 times, most recently
from
e834986
to
6ad301f
Compare
This includes both fixing links found in searchbar, and ones accessible from method names. In searchbar, links are resolved based on whether they are absolute (pointing to an external website, like java docs) or relative (pointing to another sub-website, with root being appended on runtime). This is achieved by serializing another boolean field in PageEntry.
jchyb
force-pushed
the
scaladoc/fix-i14505-i14504
branch
from
6ad301f
to
213e275
Compare
|
Thank you for spotting this as this was not something that happened locally, now I've updated the PR with fixes. I no longer use new URI(_).isAbsolute() as URI parsing seemed to be the issue. Instead, an additional filed for searchData was added describing whether the searchData contains an internal link or one to the external website. A similar technique with URIs was employed in a previous PR with Inkuire and, as it turns out, the issues would also happen there (just much more rarely), so I updated that in a separate commit. Unfortunately, as I could not add any new fields there the solution ended up being a little "hacky", but I hope it is at least explained elegantly in the comment. |
|
Thank you for the fixes! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This includes escaping certain characters found in searchbar links (1st commit) and correctly resolving external links (2nd commit).
Fixes #14505 and #14504.