Handle intra-doc links in doc_markdown
This commit is contained in:
parent
80408ef8dc
commit
2a8d7bd0dd
2 changed files with 14 additions and 8 deletions
|
@ -406,6 +406,15 @@ struct DocHeaders {
|
||||||
}
|
}
|
||||||
|
|
||||||
fn check_attrs<'a>(cx: &LateContext<'_>, valid_idents: &FxHashSet<String>, attrs: &'a [Attribute]) -> DocHeaders {
|
fn check_attrs<'a>(cx: &LateContext<'_>, valid_idents: &FxHashSet<String>, attrs: &'a [Attribute]) -> DocHeaders {
|
||||||
|
use pulldown_cmark::{BrokenLink, CowStr, Options};
|
||||||
|
/// We don't want the parser to choke on intra doc links. Since we don't
|
||||||
|
/// actually care about rendering them, just pretend that all broken links are
|
||||||
|
/// point to a fake address.
|
||||||
|
#[allow(clippy::unnecessary_wraps)] // we're following a type signature
|
||||||
|
fn fake_broken_link_callback<'a>(_: BrokenLink<'_>) -> Option<(CowStr<'a>, CowStr<'a>)> {
|
||||||
|
Some(("fake".into(), "fake".into()))
|
||||||
|
}
|
||||||
|
|
||||||
let mut doc = String::new();
|
let mut doc = String::new();
|
||||||
let mut spans = vec![];
|
let mut spans = vec![];
|
||||||
|
|
||||||
|
@ -440,7 +449,10 @@ fn check_attrs<'a>(cx: &LateContext<'_>, valid_idents: &FxHashSet<String>, attrs
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
let parser = pulldown_cmark::Parser::new(&doc).into_offset_iter();
|
let mut cb = fake_broken_link_callback;
|
||||||
|
|
||||||
|
let parser =
|
||||||
|
pulldown_cmark::Parser::new_with_broken_link_callback(&doc, Options::empty(), Some(&mut cb)).into_offset_iter();
|
||||||
// Iterate over all `Events` and combine consecutive events into one
|
// Iterate over all `Events` and combine consecutive events into one
|
||||||
let events = parser.coalesce(|previous, current| {
|
let events = parser.coalesce(|previous, current| {
|
||||||
use pulldown_cmark::Event::Text;
|
use pulldown_cmark::Event::Text;
|
||||||
|
|
|
@ -186,11 +186,5 @@ error: you should put `mycrate::Collection` between ticks in the documentation
|
||||||
LL | /// An iterator over mycrate::Collection's values.
|
LL | /// An iterator over mycrate::Collection's values.
|
||||||
| ^^^^^^^^^^^^^^^^^^^
|
| ^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
error: you should put `text][path::to::item` between ticks in the documentation
|
error: aborting due to 31 previous errors
|
||||||
--> $DIR/doc.rs:208:12
|
|
||||||
|
|
|
||||||
LL | /// [plain text][path::to::item]
|
|
||||||
| ^^^^^^^^^^^^^^^^^^^^
|
|
||||||
|
|
||||||
error: aborting due to 32 previous errors
|
|
||||||
|
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue