Skip to content
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.

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

[SR-13013] swift-format complains of missing punctuation when adding doc comments via the Xcode template #321

Open
swift-ci opened this issue Jun 14, 2020 · 1 comment
Labels
bug Something isn't working swift-format

Comments

@swift-ci
Copy link

Previous ID SR-13013
Radar None
Original Reporter leisurehound (JIRA User)
Type Bug

Attachment: Download

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

md5: 9098405131005fed6b61e5fdf05425c6

Issue Description:

When adding doc comments to a method via the Xcode shortcut, the template added is:

/// Description
/// - Parameters:
///   - param: param description

However, when entering the description and parameter description keeping the newlines as the template provides, swift format will complain about punctuation at the end of the entire doc comments, and not just the description, even if the description has punctuation.

Parameters descriptions otherwise do not seem to require punctuation.

Adding a new line between Description & - Parameters (and sometimes adding two and the deleting one is required) the swift-format punctuation concerns are alleviated.

@swift-ci swift-ci transferred this issue from apple/swift-issues Apr 25, 2022
@shahmishal shahmishal transferred this issue from apple/swift May 9, 2022
@ahoppen
Copy link
Contributor

ahoppen commented Apr 23, 2024

Tracked in Apple’s issue tracker as rdar://126948260

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working swift-format
Projects
None yet
Development

No branches or pull requests

2 participants