-
Notifications
You must be signed in to change notification settings - Fork 13k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
add missing doc links #73579
add missing doc links #73579
Conversation
r? @shepmaster (rust_highfive has picked a reviewer for you, use r? to override) |
/// - otherwise, it is conservatively not allowed to call this function. | ||
/// | ||
/// [slice]: ../../std/primitive.slice.html | ||
/// [trait object]: ../../book/ch17-02-trait-objects.html | ||
/// [extern type]: ../../unstable-book/language-features/extern-types.html | ||
/// [`size_of_val`]: ../../core/mem/fn.size_of_val.html |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this needed? https://doc.rust-lang.org/nightly/core/mem/fn.size_of_val.html already correctly links to size_of_val
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is in size_of_val_raw
though? I do not understand the question.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I meant that https://doc.rust-lang.org/nightly/core/mem/fn.size_of_val_raw.html correctly links the size_of_val
😅
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh... that's weird, I just saw it with a broken link somewhere... let me see if I can find that again.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah, the link is broken here:
https://doc.rust-lang.org/nightly/std/mem/fn.size_of_val_raw.html
Sounds like a rustdoc bug then? Cc @rust-lang/rustdoc
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's #65983. The intra-doc link feature isn't ready for use in std
yet.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Okay, seems like my patch makes sense then as it avoids using that feature.
Co-authored-by: Bastian Kauschke <[email protected]>
@bors r+ rollup |
📌 Commit cb8c94c has been approved by |
…aster add missing doc links The doc comments contain ``[`size_of_val`]`` but the link target was missing.
…aster add missing doc links The doc comments contain ``[`size_of_val`]`` but the link target was missing.
…aster add missing doc links The doc comments contain ``[`size_of_val`]`` but the link target was missing.
…arth Rollup of 12 pull requests Successful merges: - rust-lang#72771 (Warn if linking to a private item) - rust-lang#72937 (Fortanix SGX target libunwind build process changes) - rust-lang#73485 (Perform obligation deduplication to avoid buggy `ExistentialMismatch`) - rust-lang#73529 (Add liballoc impl SpecFromElem for i8) - rust-lang#73579 (add missing doc links) - rust-lang#73627 (Shortcuts for min/max on double-ended BTreeMap/BTreeSet iterators) - rust-lang#73691 (Bootstrap: detect Windows based on sys.platform) - rust-lang#73694 (Document the Self keyword) - rust-lang#73718 (Document the super keyword) - rust-lang#73728 (Document some invariants correctly/more) - rust-lang#73738 (Remove irrelevant comment) - rust-lang#73765 (Remove blank line) Failed merges: r? @ghost
The doc comments contain
[`size_of_val`]
but the link target was missing.