Cascade doc comments from protocol requirements to extensions #3301
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
Contributor
Author
|
@swift-ci Please smoke test |
1 similar comment
Contributor
Author
|
@swift-ci Please smoke test |
Contributor
|
Thank you, this is really awesome! |
Contributor
Author
|
@swift-ci Please test |
This allows authors to not have to copy and paste doc comments from requirements to default implementations to get documentation. For now, this will only be active if a protocol doesn't inherit two equivalent requirements from other protocols with doc comments. Those will need special treatment and it would be better not to just copy and paste them into the same doc comment. More output structure is needed to differentiate documentation for different protocols' requirements. rdar://problem/16512247
Contributor
Author
|
@swift-ci Smoke test |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
This allows authors to not have to copy and paste doc comments
from requirements to default implementations to get documentation.
rdar://problem/16512247