mirror of
https://github.com/rust-lang/rust.git
synced 2025-01-24 21:53:56 +00:00
Escape item search summaries
I noticed that `Pin::new()`'s search summary looked off, and I realized that the reason is that it has inline code containing `Pin<P>`, which is not escaped and thus renders as a paragraph tag!
This commit is contained in:
parent
e742158ef5
commit
4ad2d68602
@ -34,6 +34,7 @@ use std::str;
|
||||
use crate::clean::RenderedLink;
|
||||
use crate::doctest;
|
||||
use crate::html::escape::Escape;
|
||||
use crate::html::format::Buffer;
|
||||
use crate::html::highlight;
|
||||
use crate::html::toc::TocBuilder;
|
||||
|
||||
@ -41,8 +42,6 @@ use pulldown_cmark::{
|
||||
html, BrokenLink, CodeBlockKind, CowStr, Event, LinkType, Options, Parser, Tag,
|
||||
};
|
||||
|
||||
use super::format::Buffer;
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests;
|
||||
|
||||
@ -1086,7 +1085,7 @@ fn markdown_summary_with_limit(
|
||||
let mut stopped_early = false;
|
||||
|
||||
fn push(s: &mut String, text_length: &mut usize, text: &str) {
|
||||
s.push_str(text);
|
||||
write!(s, "{}", Escape(text)).unwrap();
|
||||
*text_length += text.len();
|
||||
}
|
||||
|
||||
|
@ -234,7 +234,17 @@ fn test_short_markdown_summary() {
|
||||
t("hello [Rust](https://www.rust-lang.org \"Rust\") :)", "hello Rust :)");
|
||||
t("dud [link]", "dud [link]");
|
||||
t("code `let x = i32;` ...", "code <code>let x = i32;</code> …");
|
||||
t("type `Type<'static>` ...", "type <code>Type<'static></code> …");
|
||||
t("type `Type<'static>` ...", "type <code>Type<'static></code> …");
|
||||
// Test to ensure escaping and length-limiting work well together.
|
||||
// The output should be limited based on the input length,
|
||||
// rather than the output, because escaped versions of characters
|
||||
// are usually longer than how the character is actually displayed.
|
||||
t(
|
||||
"& & & & & & & & & & & & & & & & & & & & & & & & & & & & & & & & & & & & &",
|
||||
"& & & & & & & & & & & & \
|
||||
& & & & & & & & & & & & \
|
||||
& & & & & …",
|
||||
);
|
||||
t("# top header", "top header");
|
||||
t("# top header\n\nfollowed by a paragraph", "top header");
|
||||
t("## header", "header");
|
||||
|
Loading…
Reference in New Issue
Block a user