Skip to content

Move to intra doc links for keyword documentation #75646

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Merged
merged 1 commit into from
Aug 19, 2020

Conversation

poliorcetics
Copy link
Contributor

Helps with #75080.

@rustbot modify labels: T-doc, A-intra-doc-links, T-rustdoc

@rustbot rustbot added A-intra-doc-links Area: Intra-doc links, the ability to link to items in docs by name A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Aug 17, 2020
@rust-highfive
Copy link
Contributor

r? @Mark-Simulacrum

(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 Aug 17, 2020
@Mark-Simulacrum
Copy link
Member

r? @jyn514

Copy link
Member

@jyn514 jyn514 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm confused how rustdoc didn't catch the broken links. Maybe there's a bug?

@ollie27
Copy link
Member

ollie27 commented Aug 18, 2020

I'm confused how rustdoc didn't catch the broken links. Maybe there's a bug?

I'm not seeing any broken links. The [`Fn` trait] contains a space so rustdoc doesn't consider it an intra-doc link but it's unused in this case so it should be deleted anyway. All of the other links work just fine.

@jyn514
Copy link
Member

jyn514 commented Aug 18, 2020

Ah I missed that this uses include! and not mod. This looks fine then.
https://github.com/rust-lang/rust/blob/master/library/std/src/lib.rs#L553

@jyn514
Copy link
Member

jyn514 commented Aug 18, 2020

@bors r+ rollup

@bors
Copy link
Collaborator

bors commented Aug 18, 2020

📌 Commit 431a465 has been approved by jyn514

@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 Aug 18, 2020
tmandry added a commit to tmandry/rust that referenced this pull request Aug 18, 2020
…r=jyn514

Move to intra doc links for keyword documentation

Helps with rust-lang#75080.

@rustbot modify labels: T-doc, A-intra-doc-links, T-rustdoc
tmandry added a commit to tmandry/rust that referenced this pull request Aug 18, 2020
…r=jyn514

Move to intra doc links for keyword documentation

Helps with rust-lang#75080.

@rustbot modify labels: T-doc, A-intra-doc-links, T-rustdoc
tmandry added a commit to tmandry/rust that referenced this pull request Aug 19, 2020
…r=jyn514

Move to intra doc links for keyword documentation

Helps with rust-lang#75080.

@rustbot modify labels: T-doc, A-intra-doc-links, T-rustdoc
tmandry added a commit to tmandry/rust that referenced this pull request Aug 19, 2020
…r=jyn514

Move to intra doc links for keyword documentation

Helps with rust-lang#75080.

@rustbot modify labels: T-doc, A-intra-doc-links, T-rustdoc
tmandry added a commit to tmandry/rust that referenced this pull request Aug 19, 2020
…r=jyn514

Move to intra doc links for keyword documentation

Helps with rust-lang#75080.

@rustbot modify labels: T-doc, A-intra-doc-links, T-rustdoc
bors added a commit to rust-lang-ci/rust that referenced this pull request Aug 19, 2020
Rollup of 9 pull requests

Successful merges:

 - rust-lang#75038 (See also X-Link mem::{swap, take, replace})
 - rust-lang#75049 (docs(marker/copy): provide example for `&T` being `Copy`)
 - rust-lang#75499 (Fix documentation error)
 - rust-lang#75554 (Fix clashing_extern_declarations stack overflow for recursive types.)
 - rust-lang#75646 (Move to intra doc links for keyword documentation)
 - rust-lang#75652 (Resolve true and false as booleans)
 - rust-lang#75658 (Don't emit "is not a logical operator" error outside of associative expressions)
 - rust-lang#75665 (Add doc examples coverage)
 - rust-lang#75685 (Switch to intra-doc links in /src/sys/unix/ext/*.rs)

Failed merges:

r? @ghost
@bors bors merged commit 9cf3903 into rust-lang:master Aug 19, 2020
@poliorcetics poliorcetics deleted the intra-links-keywords branch August 19, 2020 14:09
@jyn514 jyn514 removed the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Aug 25, 2020
@cuviper cuviper added this to the 1.47.0 milestone May 2, 2024
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools A-intra-doc-links Area: Intra-doc links, the ability to link to items in docs by name 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.

8 participants