Skip to content

Fix documentation for syntax collections in SwiftSyntaxBuilderGeneration #546

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Aug 4, 2022
Merged

Fix documentation for syntax collections in SwiftSyntaxBuilderGeneration #546

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 5 additions & 7 deletions Sources/SwiftSyntaxBuilderGeneration/SyntaxBuildableNode.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,12 @@ extension Node {
}

/// If documentation exists for this node, return it as a single-line string.
/// Otherwise return an empty string.
/// Otherwise return an empty string or a description of collection if this
/// node is a syntax collection.
var documentation: String {
guard let description = description,
!description.isEmpty else {
return ""
}
if isSyntaxCollection {
return "`\(syntaxKind)` represents a collection of `\(description)`"
let description = self.description ?? ""
if description.isEmpty && isSyntaxCollection {
return "`\(syntaxKind)` represents a collection of `\(collectionElementType.buildableBaseName)`"
} else {
return flattened(indentedDocumentation: description)
}
Expand Down