Don't trim trailing whitespace from doc comments

Don't trim trailing whitespace from doc comments as multiple trailing spaces indicates a hard line break in Markdown.
This commit is contained in:
riverbl 2023-12-10 20:54:22 +00:00
parent 4e814e3f24
commit 99b30ba22f

View file

@ -138,15 +138,13 @@ pub fn docs_from_attrs(attrs: &hir::Attrs) -> Option<String> {
for doc in docs { for doc in docs {
// str::lines doesn't yield anything for the empty string // str::lines doesn't yield anything for the empty string
if !doc.is_empty() { if !doc.is_empty() {
buf.extend(Itertools::intersperse( // We don't trim trailing whitespace from doc comments as multiple trailing spaces
doc.lines().map(|line| { // indicates a hard line break in Markdown.
line.char_indices() let lines = doc.lines().map(|line| {
.nth(indent) line.char_indices().nth(indent).map_or(line, |(offset, _)| &line[offset..])
.map_or(line, |(offset, _)| &line[offset..]) });
.trim_end()
}), buf.extend(Itertools::intersperse(lines, "\n"));
"\n",
));
} }
buf.push('\n'); buf.push('\n');
} }