Stop using variants storage for HTTP/REST/PropertyList sections #1104
Conversation
This file contains 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 |
patshaughnessy
approved these changes
Dec 16, 2024
Tests/SwiftDocCTests/Rendering/RenderNodeTranslatorSymbolVariantsTests.swift
Outdated
Show resolved
Hide resolved
|
@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:
Summary
This changes the different
DocumentationNodeproperties for HTTP/REST/PropertyList data to basic optional values instead ofDocumentationDataVariants.As far as I know and can tell, these types of symbols never have other language representations so it's not necessary to store their information as language varying. Removing the possibility of language variability for these properties make them easier to work with on the documentation node level.
For the same reason, the
redirectsis also changed to a basic optional value instead ofDocumentationDataVariants. It's not possible to author language-representation-specific redirects.Dependencies
None.
Testing
Nothing in particular. This isn't a user-facing change.
Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
AddedUpdated tests./bin/testscript and it succeeded[ ] Updated documentation if necessary