Adds support for "See Also" asides #96
Merged
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
“See Also” is a common kind of aside that folks parsing markdown may wish to consider. For Swift-DocC specifically, there is a lot of pre-DocC Swift documentation content that uses this style of callout: ``` - SeeAlso: ``` In order to gracefully transition this content over to Swift-DocC style asides, we should add support for them.
ethan-kusters
changed the title
seeAlso aside
ethan-kusters
commented
Jan 10, 2023
ethan-kusters
commented
Jan 10, 2023
Contributor
Author
|
@swift-ci please test |
QuietMisdreavus
approved these changes
Jan 10, 2023
Contributor
QuietMisdreavus
left a comment
QuietMisdreavus
left a comment
There was a problem hiding this comment.
Looks good, thanks!
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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://58775869
“See Also” is a common kind of aside that folks parsing markdown may wish to consider.
For Swift-DocC specifically, there is a lot of pre-DocC Swift documentation content that uses this style of callout:
In order to gracefully transition this content over to Swift-DocC style asides, we should add support for them. (There will need to be a follow-up PR in Swift-DocC to fully adopt this once this PR lands.)
Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/testscript and it succeeded