user0/rust
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Rollup merge of #144921 - lolbinarycat:rustdoc-intra-doc-gfm-141866, r=fmease,GuillaumeGomez

Browse source 
Don't emit `rustdoc::broken_intra_doc_links` for GitHub-flavored Markdown admonitions like `[!NOTE]`

fixes rust-lang/rust#141866
This commit is contained in:
Stuart Cook 2025-08-12 20:37:50 +10:00 • committed by GitHub
commit 31e5316cd9
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 20 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

16
src/librustdoc/passes/collect_intra_doc_links.rs
View file

@ -997,6 +997,7 @@ fn preprocess_link(
}
};
let is_shortcut_style = ori_link.kind == LinkType::ShortcutUnknown;
// If there's no backticks, be lenient and revert to the old behavior.
// This is to prevent churn by linting on stuff that isn't meant to be a link.
// only shortcut links have simple enough syntax that they
@ -1013,11 +1014,22 @@ fn preprocess_link(
// | has backtick | never ignore | never ignore |
// | no backtick | ignore if url-like | never ignore |
// |-------------------------------------------------------|
let ignore_urllike =
can_be_url || (ori_link.kind == LinkType::ShortcutUnknown && !ori_link.link.contains('`'));
let ignore_urllike = can_be_url || (is_shortcut_style && !ori_link.link.contains('`'));
if ignore_urllike && should_ignore_link(path_str) {
return None;
}
// If we have an intra-doc link starting with `!` (which isn't `[!]` because this is the never type), we ignore it
// as it is never valid.
//
// The case is common enough because of cases like `#[doc = include_str!("../README.md")]` which often
// uses GitHub-flavored Markdown (GFM) admonitions, such as `[!NOTE]`.
if is_shortcut_style
&& let Some(suffix) = ori_link.link.strip_prefix('!')
&& !suffix.is_empty()
&& suffix.chars().all(|c| c.is_ascii_alphabetic())
{
return None;
}
// Strip generics from the path.
let path_str = match strip_generics_from_path(path_str) {

6
tests/rustdoc-ui/intra-doc/github-flavored-admonitions.rs Normal file
View file

@ -0,0 +1,6 @@
// regression test for https://github.com/rust-lang/rust/issues/141866
//@ check-pass
#![deny(rustdoc::broken_intra_doc_links)]
//! > [!NOTE]
//! > This should not cause any warnings