update SymbolKit to include apple/swift-docc-symbolkit#44 #326
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 |
franklinsch
approved these changes
Jul 1, 2022
rdar://96216773
QuietMisdreavus
force-pushed
the
comment-spaces
branch
from
5fe2096 to
161ed75
Compare
|
@swift-ci Please test |
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://96216773
Summary
When #314 was added, it didn't include all the relevant changes to SymbolKit. Specifically, it didn't include swiftlang/swift-docc-symbolkit#44, which handles decoding ill-formatted URLs that include unescaped spaces. This caused a failure when building documentation for swift-argument-parser, which uses spaces in its source directories.
I've also added tests that ensure that doc comment file paths that include spaces in the JSON properly decode without error.
Dependencies
None (the relevant change has already been merged)
Testing
Build documentation with symbol graphs that use spaces in their file names, e.g. swift-argument-parser.
Steps:
xcodebuild clean docbuild -scheme ArgumentParser -destination platform=macOS DOCC_EXEC=/path/to/swift-docc/.build/debug/doccChecklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/testscript and it succeeded