Docs: Fix parentheses in Markdown link URL #61675
Closed
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.
What?
Parentheses in Markdown link URLs can be confusing, some tooling will attempt to fix them (prettier/prettier#15340):
Original:
['minifies'](https://en.wikipedia.org/wiki/Minification_(programming))
"fixed":
['minifies'](<https://en.wikipedia.org/wiki/Minification_(programming)>)
I believe both formats are technically valid, but the simplest fix is to URL encode the parens like this page recommends:
I've applied that suggestion here.
Extracted from #61486 (my editor ran prettier and "fixed" the link).
Why?
The markdown link is more likely to be treated correctly by all markdown parsers.
Testing Instructions
Look at the rendered markdown in the diff and confirm the link works correctly.