mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

rustdoc: Note that forbidding anchors in links to primitives is a bug

Browse Source
This commit is contained in:
Joshua Nelson 2021-04-14 16:39:58 -04:00
parent bc66b92f7f
commit a19e1034d4
2 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/librustdoc/passes/collect_intra_doc_links.rs
View File

@ -1913,6 +1913,10 @@ fn anchor_failure(cx: &DocContext<'_>, diag_info: DiagnosticInfo<'_>, failure: A
if let Some(sp) = sp { if let Some(sp) = sp {
diag.span_label(sp, "contains invalid anchor"); diag.span_label(sp, "contains invalid anchor");
} }
if let AnchorFailure::RustdocAnchorConflict(Res::Primitive(_)) = failure {
diag.note("this restriction may be lifted in a future release");
diag.note("see https://github.com/rust-lang/rust/issues/83083 for more information");
}
}); });
} }

5
src/test/rustdoc-ui/intra-doc/anchors.stderr
View File

@ -9,6 +9,8 @@ note: the lint level is defined here
| |
LL | #![deny(rustdoc::broken_intra_doc_links)] LL | #![deny(rustdoc::broken_intra_doc_links)]
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
= note: this restriction may be lifted in a future release
= note: see https://github.com/rust-lang/rust/issues/83083 for more information
error: `Foo::f#hola` contains an anchor, but links to fields are already anchored error: `Foo::f#hola` contains an anchor, but links to fields are already anchored
--> $DIR/anchors.rs:25:15 --> $DIR/anchors.rs:25:15
@ -33,6 +35,9 @@ error: `u32#hello` contains an anchor, but links to builtin types are already an
| |
LL | /// [u32#hello] LL | /// [u32#hello]
| ^^^^^^^^^ contains invalid anchor | ^^^^^^^^^ contains invalid anchor
|
= note: this restriction may be lifted in a future release
= note: see https://github.com/rust-lang/rust/issues/83083 for more information
error: aborting due to 5 previous errors error: aborting due to 5 previous errors