-
Notifications
You must be signed in to change notification settings - Fork 128
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Allow certain directives #641
Merged
emilyychenn
merged 16 commits into
swiftlang:main
from
emilyychenn:allow-certain-directives
Jun 27, 2023
Merged
Allow certain directives #641
emilyychenn
merged 16 commits into
swiftlang:main
from
emilyychenn:allow-certain-directives
Jun 27, 2023
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 |
Co-authored-by: Ethan Kusters <ekusters@apple.com>
@swift-ci please test |
Co-authored-by: Ethan Kusters <ekusters@apple.com>
@swift-ci please test |
ethan-kusters
approved these changes
Jun 27, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great! Thank you!
@swift-ci please test |
emilyychenn
added a commit
to emilyychenn/swift-docc
that referenced
this pull request
Jun 27, 2023
Allow certain directives in documentation comments rdar://111414385
emilyychenn
added a commit
that referenced
this pull request
Jun 28, 2023
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: #591
Summary
Allow some directives in doc comments. This feature is motivated by allowing the
@Snippet
directive in doc comments, as was noted here: https://forums.swift.org/t/using-snippets-in-documentation-comments-not-possible/65046.Testing
With a documentation catalog
In a documentation catalog with symbol graph files and documentation extension files:
docc preview /path/to/Example.docc
Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/test
script and it succeeded