Skip to content

rustdoc: Hide #text in doc-tests #84445

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 23, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 13 additions & 6 deletions src/librustdoc/html/markdown.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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))
}
Expand Down
25 changes: 25 additions & 0 deletions src/test/rustdoc-ui/test-hidden.rs
Original file line number Diff line number Diff line change
@@ -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 changes: 6 additions & 0 deletions src/test/rustdoc-ui/test-hidden.stdout
Original file line number Diff line number Diff line change
@@ -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