Column limits don't seem to apply to comments

[dabrahams]

Description

I want column limits respected even in comments, and I want them to be automatically line-wrapped, preserving markdown semantics within doc comments.

Steps to Reproduce

Run swift-format lint on:

// 01234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789

It should complain, but does not.

[allevato]

Did you mean to file this over at apple/swift-format?

The current behavior is WAI, but I'd like to make improvements here. Treating comments as Markdown resolves the majority of my concerns around formatting comments (a long URL? Markdown will still preserve it past the line limit. Some fancy ASCII art diagram? Wrap it in triple-backticks to preserve it), but we'll need semver releases over at https://github.com/apple/swift-markdown before we can adopt it.

[dabrahams]

Did you mean to file this over at apple/swift-format?

Uh, yeah. Can it be moved? Should I refile?

WAI

?

[allevato]

Did you mean to file this over at apple/swift-format?

Uh, yeah. Can it be moved? Should I refile?

I've transferred it over.

WAI

?

Working as intended (under the constraints today, which is that I don't want us to implement our own line-breaking logic for prose, and using swift-markdown would fix that).

[ahoppen]

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

[shawnhyam]

I tried using swift-markdown to format doc comments, and while the results were mostly good, there was one issue in particular that really broke the formatting. A line like this:

/// The break maintains the existing value of `currentLineIsContinuation` when it fires.

would get reformatted as:

/// The break maintains the existing value of
///
///
/// `currentLineIsContinuation` when it fires.

Whenever the line would wrap on a piece of text that was enclosed in a backtick, it would treat it as a new paragraph. There were some other issues with double line breaks for new paragraphs, and using blank spaces instead of backslash for line continuations (which are in danger of being removed by the editor), but this was the biggest problem.

[allevato]

That looks like it would be a bug in swift-markdown, because an inline node shouldn't cause a paragraph break like that. If you can repro it standalone, can you file an issue over there and see what they say?

[shawnhyam]

Issue created: swiftlang/swift-markdown#197