diff options
| author | Michael Howell <michael@notriddle.com> | 2021-03-09 17:48:14 -0700 |
|---|---|---|
| committer | Michael Howell <michael@notriddle.com> | 2021-03-09 17:48:14 -0700 |
| commit | e40b3d6a3875fced1e11d5cc952cd3081c5f2710 (patch) | |
| tree | a45787c5b52505fca27762c8d82a34bd89a9dd7e | |
| parent | 3a5d45f68cadc8fff4fbb557780f92b403b19c19 (diff) | |
| download | rust-e40b3d6a3875fced1e11d5cc952cd3081c5f2710.tar.gz rust-e40b3d6a3875fced1e11d5cc952cd3081c5f2710.zip | |
Treat header as first paragraph for shortened markdown descriptions
"The Rust Standard LibraryThe Rust Standard Library is the …" is an awful description.
| -rw-r--r-- | src/librustdoc/html/markdown.rs | 1 | ||||
| -rw-r--r-- | src/librustdoc/html/markdown/tests.rs | 1 |
2 files changed, 2 insertions, 0 deletions
diff --git a/src/librustdoc/html/markdown.rs b/src/librustdoc/html/markdown.rs index ccc51c243ad..1505fe0369d 100644 --- a/src/librustdoc/html/markdown.rs +++ b/src/librustdoc/html/markdown.rs @@ -1093,6 +1093,7 @@ fn markdown_summary_with_limit(md: &str, length_limit: usize) -> (String, bool) Tag::Emphasis => s.push_str("</em>"), Tag::Strong => s.push_str("</strong>"), Tag::Paragraph => break, + Tag::Heading(..) => break, _ => {} }, Event::HardBreak | Event::SoftBreak => { diff --git a/src/librustdoc/html/markdown/tests.rs b/src/librustdoc/html/markdown/tests.rs index e2ce9ad23f4..ac3ea4c8c5f 100644 --- a/src/librustdoc/html/markdown/tests.rs +++ b/src/librustdoc/html/markdown/tests.rs @@ -235,6 +235,7 @@ fn test_short_markdown_summary() { t("code `let x = i32;` ...", "code <code>let x = i32;</code> …"); t("type `Type<'static>` ...", "type <code>Type<'static></code> …"); t("# top header", "top header"); + t("# top header\n\nfollowed by a paragraph", "top header"); t("## header", "header"); t("first paragraph\n\nsecond paragraph", "first paragraph"); t("```\nfn main() {}\n```", ""); |
