wrap_comments wraps (long) headers

[virtualritz]

Input (from the miette crate's docs):

/// # Wrapping Types That Do Not Implement `Error` (e.g. `&str` and `Box<dyn Error>`)

After cargo fmt with rustfmt.toml:

edition = "2021"
wrap_comments = true
format_code_in_doc_comments = true

Output:

/// # Wrapping Types That Do Not Implement `Error` (e.g. `&str` and `Box<dyn
/// Error>`)

Which renders as:

Fix

Do not ever break comment lines starting with # even when wrap_comments is set.

[ytmimi]

Thanks for submitting this report!

I think the proposed fix makes sense, and I should have a fix for this soon!

[ytmimi]

@rustbot claim

[ytmimi]

Looking into this a little more I think only the wrap_comments = true configuration option is causing the issue. Appreciate you listing all the options you're using though!

[virtualritz]

Yes, I assumed this (see title of this issue) but since I didn't have time to test this assumption I thought I dump the entire rustfmt.toml in use in miette. 😀