Skip to content

[SR-15711] ValidateDocumentationComments rule omits checking any tags if a description doesn't contain period #299

Open
@swift-ci

Description

@swift-ci
Previous ID SR-15711
Radar rdar://problem/9836857
Original Reporter griffin-stewie (JIRA User)
Type Bug
Environment

Swift: v5.5.2

Xcode: v13.2.1

Additional Detail from JIRA
Votes 0
Component/s swift-format
Labels Bug
Assignee None
Priority Medium

md5: 65eee4a55d51d6707ef5e2cb476fa2a9

Issue Description:

I understand [this behavior is design |https://github.com/apple/swift-format/blob/f872223e16742fd97fabd319fbf4a939230cc796/Tests/SwiftFormatRulesTests/ValidateDocumentationCommentsTests.swift#L177.]

However, If you inadvertently forget to type a period, it can slip through without being inspected. Also, if you write a document comment in a language that does not use periods as sentence separators, such as Japanese, it will not be checked as well.

At the very least, I think it would be better to perform input checking for document comments that have arguments and other tags entered.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions