Add experimental-skip-synthesized-symbols parameter for doc generation on SPI #2177
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
finestructure
commented
Sep 11, 2023
.spi.yml
Outdated
| @@ -21,3 +21,5 @@ builder: | |||
| - SwiftSyntaxMacros | |||
| - SwiftSyntaxMacroExpansion | |||
| - SwiftSyntaxMacrosTestSupport | |||
| custom_documentation_parameters: [--experimental-skip-synthesized-symbols] | |||
| swift_version: '5.9' | |||
There was a problem hiding this comment.
Ethan mentioned the flag should be supported on 5.8 as well (which is what we use to generate the docs by default), so this additional key is perhaps not necessary. I can run a test before merging.
There was a problem hiding this comment.
I've confirmed this works on 5.8 and with the double dash command.
Size (/MB): 146.0
File count: 16557
ahoppen
approved these changes
Sep 11, 2023
|
@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.
As just discussed on the Documentation WG, setting this parameter shrinks the generated docs down dramatically:
cc @ethan-kusters