[5.7] Allow writing doc links to subsections using special characters (#262) #265
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
Contributor
d-ronnqvist
commented
May 25, 2022
d-ronnqvist
commented
- Rationale: This improves the UX of writing links to on-page subsections when those on-page headings contains apostrophes, punctuation, or special characters.
- Risk: Low
- Risk Detail: This is a targeted change to how links to on-page headings are written and the URLs those headings get. The heading URL could have a collision if the titles for two or more headings on the same page only differ by punctuation characters but the odds of that are low.
- Reward: Medium
- Reward Details: Developers no longer need to write percent encoded links when headings contain punctuation or other special characters that are not allowed in the fragment of a URL.
- Original PR: Allow writing doc links to subsections using special characters #262
- Issue: rdar://93458581
- Code Reviewed By: @franklinsch
- Testing Details: Added automated tests to verify that various forms of links to subsections using punctuation and special characters resolve successfully.
…tlang#262) * Allow writing doc links to subsections using special characters rdar://93458581 * Rename ValidatedURL initializers to indicate intended use at call site
|
@swift-ci please test |
franklinsch
approved these changes
May 25, 2022
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.