Format doc comments so they render better in docc #2034
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
|
@swift-ci Please test |
bnbarham
reviewed
Aug 9, 2023
| An associated type declaration like the following. | ||
| An `associatedtype` declaration | ||
|
|
||
| For exmaple, an associatedtype declaration can look like the following. |
There was a problem hiding this comment.
Typo in example but I think for all these I would just remove everything after For example
There was a problem hiding this comment.
Removed For example from all these comments
bnbarham
approved these changes
Aug 9, 2023
ahoppen
force-pushed
the
ahoppen/format-documentation
branch
from
8aa710c to
f54f5f6
Compare
|
@swift-ci Please test |
Add a couple of line breaks to doc comments so they render more nicely in docc. For example, `DO NOT CONFORM TO THIS PROTOCOL YOURSELF!` should not show up in the abstract of the base syntax nodes
ahoppen
force-pushed
the
ahoppen/format-documentation
branch
from
f54f5f6 to
101c441
Compare
|
@swift-ci Please test |
|
@swift-ci Please test windows |
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.
Add a couple of line breaks to doc comments so they render more nicely in docc.
For example,
DO NOT CONFORM TO THIS PROTOCOL YOURSELF!should not show up in the abstract of the base syntax nodes