Allow writing doc links to subsections using special characters #262
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
|
@swift-ci please test |
|
@swift-ci please test |
franklinsch
approved these changes
May 25, 2022
d-ronnqvist
added a commit
to d-ronnqvist/swift-docc
that referenced
this pull request
May 25, 2022
…tlang#262) * Allow writing doc links to subsections using special characters rdar://93458581 * Rename ValidatedURL initializers to indicate intended use at call site
d-ronnqvist
added a commit
that referenced
this pull request
May 25, 2022
#265) * Allow writing doc links to subsections using special characters rdar://93458581 * Rename ValidatedURL initializers to indicate intended use at call site
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.
Bug/issue #, if applicable: rdar://93458581
Summary
This makes two changes related to doc links to subsections (doc links with fragments):
Dependencies
None.
Testing
In a DocC catalog with at least one article or documentation extension file:
Add a few headings that contain punctuation characters
Write links to those articles as
<doc:article-file-name#Heading-name-with-punctuation>The doc links to those subsections should resolve both with and without punctuation
Add a few headings that contain emoji or other unicode characters
Write links to those articles as
<doc:article-file-name#emoji-or-other-unicode-character>The doc links to those subsections should resolve without needing to percent encode the emoji or unicode characters.
Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/testscript and it succeeded