Skip to content

Commit

Permalink
Rollup merge of #84201 - jyn514:primitive-warnings, r=cuviper
Browse files Browse the repository at this point in the history
rustdoc: Note that forbidding anchors in links to primitives is a bug

cc #83083, #84147 (comment)

r? `@cuviper`
  • Loading branch information
Dylan-DPC authored Apr 14, 2021
2 parents f53d1a2 + a19e103 commit f4549d2
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 0 deletions.
4 changes: 4 additions & 0 deletions src/librustdoc/passes/collect_intra_doc_links.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1972,6 +1972,10 @@ fn anchor_failure(cx: &DocContext<'_>, diag_info: DiagnosticInfo<'_>, failure: A
if let Some(sp) = sp {
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");
}
});
}

Expand Down
5 changes: 5 additions & 0 deletions src/test/rustdoc-ui/intra-doc/anchors.stderr
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ note: the lint level is defined here
|
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
--> $DIR/anchors.rs:25:15
Expand All @@ -33,6 +35,9 @@ error: `u32#hello` contains an anchor, but links to builtin types are already an
|
LL | /// [u32#hello]
| ^^^^^^^^^ 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

0 comments on commit f4549d2

Please sign in to comment.