Improve modeling of Child in CodeGeneration
#1914
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 |
Matejkob
reviewed
Jul 17, 2023
| public let documentation: SwiftSyntax.Trivia | ||
|
|
||
| /// The first line of the child's documentation | ||
| public let documentationAbstract: String |
There was a problem hiding this comment.
I've been thinking if this also should be using a Trivia type but in the end a String type makes more sense. Changing it would mean that in methods like this: func generateInitializerDocComment() -> SwiftSyntax.Trivia we would have to use something like TriviaPiece.commentValue property proposed in #1890.
There was a problem hiding this comment.
Yes, the problem is that we use this string for the parameter documentation of the node’s initializers. And for those, we don’t want it prefixed with ///
bnbarham
approved these changes
Jul 18, 2023
ahoppen
force-pushed
the
ahoppen/child-improvements
branch
from
f8cc5a2 to
cc6fca0
Compare
ahoppen
force-pushed
the
ahoppen/child-improvements
branch
from
cc6fca0 to
7b8e86b
Compare
|
@swift-ci Please test |
This also fixes a bug that caused multi-line documentation of children to be rendered incorrectly
ahoppen
force-pushed
the
ahoppen/child-improvements
branch
from
7b8e86b to
9adf2df
Compare
|
@swift-ci Please test |
|
@swift-ci Please test Windows |
kimdv
approved these changes
Jul 18, 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.
Two changes:
Child.varNameaTokenSyntaxChild.documentationtoTrivia