mirror of
https://github.com/rust-lang/rust.git
synced 2024-11-28 01:34:21 +00:00
rustdoc: Hide #text
in doc-tests
Since `#![attr]` and `#[attr]` are the only valid syntax that start with `#`, we can just special case those two tokens.
This commit is contained in:
parent
25c15cdbe0
commit
af6c3201fc
@ -147,12 +147,19 @@ fn map_line(s: &str) -> Line<'_> {
|
||||
let trimmed = s.trim();
|
||||
if trimmed.starts_with("##") {
|
||||
Line::Shown(Cow::Owned(s.replacen("##", "#", 1)))
|
||||
} else if let Some(stripped) = trimmed.strip_prefix("# ") {
|
||||
// # text
|
||||
Line::Hidden(&stripped)
|
||||
} else if trimmed == "#" {
|
||||
// We cannot handle '#text' because it could be #[attr].
|
||||
Line::Hidden("")
|
||||
} else if trimmed.starts_with('#') {
|
||||
let mut without_hash = trimmed[1..].trim_start();
|
||||
if without_hash.starts_with('!') {
|
||||
// #! text
|
||||
without_hash = without_hash[1..].trim_start_matches(' ');
|
||||
}
|
||||
if without_hash.starts_with('[') {
|
||||
// #[attr] or #![attr]
|
||||
Line::Shown(Cow::Borrowed(s))
|
||||
} else {
|
||||
// #text
|
||||
Line::Hidden(without_hash)
|
||||
}
|
||||
} else {
|
||||
Line::Shown(Cow::Borrowed(s))
|
||||
}
|
||||
|
25
src/test/rustdoc-ui/test-hidden.rs
Normal file
25
src/test/rustdoc-ui/test-hidden.rs
Normal file
@ -0,0 +1,25 @@
|
||||
// check-pass
|
||||
// compile-flags:--test
|
||||
// normalize-stdout-test "finished in \d+\.\d+s" -> "finished in $$TIME"
|
||||
// normalize-stdout-test: "src/test/rustdoc-ui" -> "$$DIR"
|
||||
|
||||
/// ```
|
||||
// If `const_err` becomes a hard error in the future, please replace this with another
|
||||
// deny-by-default lint instead of removing it altogether
|
||||
/// # ! [allow(const_err)]
|
||||
/// const C: usize = 1/0;
|
||||
///
|
||||
/// # use std::path::PathBuf;
|
||||
/// #use std::path::Path;
|
||||
/// let x = Path::new("y.rs");
|
||||
/// let x = PathBuf::from("y.rs");
|
||||
///
|
||||
/// #[cfg(FALSE)]
|
||||
/// assert!(false);
|
||||
///
|
||||
/// # [cfg(FALSE)]
|
||||
/// assert!(false);
|
||||
/// ```
|
||||
fn main() {
|
||||
panic!();
|
||||
}
|
6
src/test/rustdoc-ui/test-hidden.stdout
Normal file
6
src/test/rustdoc-ui/test-hidden.stdout
Normal file
@ -0,0 +1,6 @@
|
||||
|
||||
running 1 test
|
||||
test $DIR/test-hidden.rs - main (line 6) ... ok
|
||||
|
||||
test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in $TIME
|
||||
|
Loading…
Reference in New Issue
Block a user