rust/tests/target/issue-5238/markdown_header_wrap_comments_true.rs
Yacin Tmimi 272fb42f06 Prevent wrapping markdown headers in doc comments
Fixes 5238

A markdown header is defined by a string that starts with `#`.

Previously, rustfmt would wrap long markdown headers when
`wrap_comments=true`. This lead to issues when rendering these headers
in HTML using rustdoc.

Now, rustfmt leaves markdown headers alone when wrapping comments.
2022-02-28 23:25:49 -06:00

15 lines
614 B
Rust

// rustfmt-wrap_comments: true
/// no markdown header so rustfmt should wrap this comment when
/// `format_code_in_doc_comments = true` and `wrap_comments = true`
fn not_documented_with_markdown_header() {
// This is just a normal inline comment so rustfmt should wrap this comment
// when `wrap_comments = true`
}
/// # We're using a markdown header here so rustfmt should refuse to wrap this comment in all circumstances
fn documented_with_markdown_header() {
// # We're using a markdown header in an inline comment. rustfmt should be
// able to wrap this comment when `wrap_comments = true`
}