Skip to content

Disabling AllPublicDeclarationsHaveDocumentation conflicts with coding guidelines #131

@leogdion

Description

@leogdion

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:

  1. Keep AllPublicDeclarationsHaveDocumentation enabled, OR
  2. 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

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingdocumentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions