Skip to content

Commit 0142e80

Browse files
committed
rustdoc: Write blank lines after brief descriptions
1 parent 971236e commit 0142e80

File tree

1 file changed

+23
-2
lines changed

1 file changed

+23
-2
lines changed

src/rustdoc/gen.rs

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,7 @@ fn write_fn(
9494
alt doc.brief {
9595
some(brief) {
9696
ctxt.w.write_line(brief);
97+
ctxt.w.write_line("");
9798
}
9899
none. { }
99100
}
@@ -145,7 +146,7 @@ mod tests {
145146
let ast = parse::from_str(source);
146147
let doc = extract::extract(ast, "belch");
147148
let markdown = write_markdown_str(doc);
148-
assert str::contains(markdown, "# Crate belch\n");
149+
assert str::contains(markdown, "# Crate belch");
149150
}
150151

151152
#[test]
@@ -172,6 +173,26 @@ mod tests {
172173
let ast = parse::from_str(source);
173174
let doc = extract::extract(ast, "");
174175
let markdown = write_markdown_str(doc);
175-
assert str::contains(markdown, "Module `morp`\n");
176+
assert str::contains(markdown, "Module `morp`\n\n");
177+
}
178+
179+
#[test]
180+
fn should_leave_blank_line_between_fn_header_and_brief() {
181+
let source = "#[doc(brief = \"brief\")] fn a() { }";
182+
let srv = astsrv::mk_srv_from_str(source);
183+
let doc = extract::from_srv(srv, "");
184+
let doc = attr_pass::mk_pass()(srv, doc);
185+
let markdown = write_markdown_str(doc);
186+
assert str::contains(markdown, "Function `a`\n\nbrief");
187+
}
188+
189+
#[test]
190+
fn should_leve_blank_line_after_brief() {
191+
let source = "#[doc(brief = \"brief\")] fn a() { }";
192+
let srv = astsrv::mk_srv_from_str(source);
193+
let doc = extract::from_srv(srv, "");
194+
let doc = attr_pass::mk_pass()(srv, doc);
195+
let markdown = write_markdown_str(doc);
196+
assert str::contains(markdown, "brief\n\n");
176197
}
177198
}

0 commit comments

Comments
 (0)