-
Notifications
You must be signed in to change notification settings - Fork 0
Closed
Labels
bugSomething isn't workingSomething isn't workingdocumentationImprovements or additions to documentationImprovements or additions to documentation
Milestone
Description
Severity: 🟠 Major
File: .swift-format:27
PR: #126
Issue
Setting AllPublicDeclarationsHaveDocumentation to false contradicts the project's coding guideline requiring "comprehensive doc comments on all public APIs following DocC standards."
This could lead to incomplete API documentation, especially given the extensive new public APIs added in PR #126:
- DataSource
- DataSourceMetadata
- FetchConfiguration
- And related types
Recommendation
Either:
- Keep
AllPublicDeclarationsHaveDocumentationenabled, OR - Document the rationale for disabling it in the PR description with a link to an approved exception
CodeRabbit Suggestion
In @.swift-format around line 27, The .swift-format change disables
AllPublicDeclarationsHaveDocumentation which conflicts with the project's
guideline requiring DocC comments for public APIs; either re-enable
AllPublicDeclarationsHaveDocumentation or, if you must disable it, add a short
rationale comment in the PR description (and a link to an approved exception)
and ensure all new public types and symbols introduced in this PR (e.g.,
DataSource, DataSourceMetadata, FetchConfiguration and any public
methods/protocols) include comprehensive DocC comments before merging.
Source: CodeRabbit AI review of PR #126
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
bugSomething isn't workingSomething isn't workingdocumentationImprovements or additions to documentationImprovements or additions to documentation