Skip to content

Make ValidateDocumentationComments allow Throws doc comments for rethrows functions #948

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
Mar 4, 2025
Merged

Make ValidateDocumentationComments allow Throws doc comments for rethrows functions #948

Show file tree
Hide file tree
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
9 changes: 5 additions & 4 deletions Sources/SwiftFormat/Rules/ValidateDocumentationComments.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,12 +131,13 @@ public final class ValidateDocumentationComments: SyntaxLintRule {
throwsDescription: Paragraph?,
node: DeclSyntax
) {
// If a function is marked as `rethrows`, it doesn't have any errors of its
// own that should be documented. So only require documentation for
// functions marked `throws`.
// Documentation is required for functions marked as `throws`.
// For functions marked as `rethrows`, documentation is not enforced
// since they don’t introduce new errors of their own.
// However, it can still be included if needed.
let needsThrowsDesc = throwsOrRethrowsKeyword?.tokenKind == .keyword(.throws)

if !needsThrowsDesc && throwsDescription != nil {
if throwsOrRethrowsKeyword == nil && throwsDescription != nil {
diagnose(
.removeThrowsComment(funcName: name),
on: throwsOrRethrowsKeyword ?? node.firstToken(viewMode: .sourceAccurate)
Expand Down
1 change: 0 additions & 1 deletion Tests/SwiftFormatTests/Rules/ValidateDocumentationCommentsTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,6 @@ final class ValidateDocumentationCommentsTests: LintOrFormatRuleTestCase {
findings: [
FindingSpec("1️⃣", message: "remove the 'Throws:' sections of 'doesNotThrow'; it does not throw any errors"),
FindingSpec("2️⃣", message: "add a 'Throws:' section to document the errors thrown by 'doesThrow'"),
FindingSpec("3️⃣", message: "remove the 'Throws:' sections of 'doesRethrow'; it does not throw any errors"),
]
)
}
Expand Down