Skip to content
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

Merged
merged 3 commits into from
Jun 27, 2020
Merged

add missing doc links #73579

merged 3 commits into from
Jun 27, 2020

Conversation

RalfJung
Copy link
Member

The doc comments contain [`size_of_val`] but the link target was missing.

@rust-highfive
Copy link
Collaborator

r? @shepmaster

(rust_highfive has picked a reviewer for you, use r? to override)

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jun 21, 2020
/// - 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
Copy link
Contributor

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

Copy link
Member Author

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.

Copy link
Contributor

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 😅

Copy link
Member Author

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.

Copy link
Member Author

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

Copy link
Member

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.

Copy link
Member Author

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.

src/libcore/mem/mod.rs Outdated Show resolved Hide resolved
src/libcore/mem/mod.rs Outdated Show resolved Hide resolved
Co-authored-by: Bastian Kauschke <bastian_kauschke@hotmail.de>
@shepmaster
Copy link
Member

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Jun 26, 2020

📌 Commit cb8c94c has been approved by shepmaster

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jun 26, 2020
Manishearth added a commit to Manishearth/rust that referenced this pull request Jun 26, 2020
…aster

add missing doc links

The doc comments contain ``[`size_of_val`]`` but the link target was missing.
Manishearth added a commit to Manishearth/rust that referenced this pull request Jun 26, 2020
…aster

add missing doc links

The doc comments contain ``[`size_of_val`]`` but the link target was missing.
Manishearth added a commit to Manishearth/rust that referenced this pull request Jun 26, 2020
…aster

add missing doc links

The doc comments contain ``[`size_of_val`]`` but the link target was missing.
This was referenced Jun 26, 2020
bors added a commit to rust-lang-ci/rust that referenced this pull request Jun 27, 2020
…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
@bors bors merged commit 92af945 into rust-lang:master Jun 27, 2020
@RalfJung RalfJung deleted the doc-missing-links branch June 28, 2020 07:19
@cuviper cuviper added this to the 1.46 milestone May 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

8 participants