fix broken intra doc links #1767
Conversation
| /// Despite using the word "undefined" (following Intel's naming scheme), this non-deterministically | ||
| /// picks some valid value and is not equivalent to [`mem::MaybeUninit`]. | ||
| /// In practice, this is typically equivalent to [`mem::zeroed`]. | ||
| /// picks some valid value and is not equivalent to [`mem::MaybeUninit`](core::mem::MaybeUninit). |
There was a problem hiding this comment.
Since core_arch is directly included in core, I don't think this will work. Wouldn't the correct link be crate::mem::MaybeUninit?
There was a problem hiding this comment.
im not sure that works... i guess the safest way to do it is to directly link to https://doc.rust-lang.org/std/mem/union.MaybeUninit.html ?
There was a problem hiding this comment.
Have you checked that using core::mem::MaybeUninit actually builds correctly in rust-lang/rust and passes tests? If so then it's probably fine.
There was a problem hiding this comment.
i dont actually know as i cant figure out how to reproduce the CI failure locally.
There was a problem hiding this comment.
You can probably repro it locally by running ./x doc. This will build the docs, and should repro the failure (if you have x86 system, then it should definitely work, otherwise you might need to add and specify a x86 target, as these doc problems are in x86)
There was a problem hiding this comment.
yeah, i thought as much, but it wasnt reproducing the failure
There was a problem hiding this comment.
weird! it repros in my x86 machine. But anyway, I tried with crate::mem, and it worked. The rustc repo always uses crate for core, because that enables use of the latest features (while compiling rustc, core is the previous stage compiler)
There was a problem hiding this comment.
ill take your word for it
bend-n
force-pushed
the
rustdoc᠄᠄broken_intra_doc_links
branch
from
545d80e to
a042adc
Compare
|
I think instead of adding specific lints to |
| /// Despite using the word "undefined" (following Intel's naming scheme), this non-deterministically | ||
| /// picks some valid value and is not equivalent to [`mem::MaybeUninit`]. | ||
| /// In practice, this is typically equivalent to [`mem::zeroed`]. | ||
| /// picks some valid value and is not equivalent to [`mem::MaybeUninit`](crate::mem::::MaybeUninit). |
There was a problem hiding this comment.
You seem to have added too many :: here.
bend-n
force-pushed
the
rustdoc᠄᠄broken_intra_doc_links
branch
2 times, most recently
from
304e6a8 to
4eb734c
Compare
|
You have to add |
|
i tried that with just or on ci, for that matter |
bend-n
force-pushed
the
rustdoc᠄᠄broken_intra_doc_links
branch
from
ec3ebc1 to
4eb734c
Compare
|
Ok finally figured it out, |
bend-n
force-pushed
the
rustdoc᠄᠄broken_intra_doc_links
branch
from
d02b942 to
4a54bbc
Compare
4 participants
there appears to have been some broken doc links here, which are inhibiting my stdarch update
this pr fixes those broken doc links.