This repository was archived by the owner on Apr 12, 2024. It is now read-only.
docs($resource): JSDoc Parsing of ) in Link #15825
Closed
Conversation
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
JSDoc to HTML converter was catching the close parenthesis in `[MDN](...#toJson()_behavior)` from the `toJson()` and treating it as the final close parenthesis. End result was a link to MDN that didn't link to the correct section, but did resolve. It was followed by a non-link "_behavior)". Updated version with percent encoding correct resolves to desired section and gets parsed to the correct link in JSDoc to HTML.
|
Travis CI error seems unrelated to PR as this change seems unlikely to have caused a
at I feel like (unrelated) CI failures happen almost every time I contribute though... It's weird. |
gkalpak
pushed a commit
that referenced
this pull request
Mar 20, 2017
JSDoc to HTML converter was treating the close parenthesis in `[MDN](...#toJson()_behavior)` as the final close parenthesis, thus resulting in a broken link. This commit fixes it by percent-encoding the parentesis in the link address. Closes #15825
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
JSDoc to HTML converter was catching the close parenthesis in
[MDN](...#toJson()_behavior)from thetoJson()and treating it as the final close parenthesis.End result was a link to MDN that didn't link to the correct section, but did resolve. It was followed by a non-link "_behavior)".
Updated version with percent encoding correct resolves to desired section and gets parsed to the correct link in JSDoc to HTML.
What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
Docs update. Also sorta a bug.
What is the current behavior? (You can also link to an open issue here)
Link works, but doesn't point to desired section. Side-effect of leaving a literal "_behavior)" artifact in the docs.
What is the new behavior (if this is a feature change)?
Link work, and now points to correct section through the magic of percent encoding. Also removes artifact as expected.
Does this PR introduce a breaking change?
No.
Please check if the PR fulfills these requirements
Other information: