Skip to content

Move to intra doc links for keyword documentation - #75646

Merged
bors merged 1 commit into
rust-lang:masterfrom
poliorcetics:intra-links-keywords
Aug 19, 2020
Merged

Move to intra doc links for keyword documentation#75646
bors merged 1 commit into
rust-lang:masterfrom
poliorcetics:intra-links-keywords

Conversation

@poliorcetics

@poliorceticspoliorcetics commented Aug 17, 2020

Copy link
Copy Markdown
Contributor

Helps with #75080.

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

@rustbotrustbot 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

rust-highfive commented Aug 17, 2020

Copy link
Copy Markdown
Contributor

r? @Mark-Simulacrum

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

@rust-highfiverust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Aug 17, 2020
@Mark-Simulacrum

Mark-Simulacrum commented Aug 17, 2020

Copy link
Copy Markdown
Member

r? @jyn514

jyn514
jyn514 reviewed Aug 17, 2020
View reviewed changes

@jyn514jyn514 left a comment

Copy link
Copy Markdown
Member

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?

Comment threadlibrary/std/src/keyword_docs.rs
Comment threadlibrary/std/src/keyword_docs.rs
Comment threadlibrary/std/src/keyword_docs.rs
Comment threadlibrary/std/src/keyword_docs.rs
Comment threadlibrary/std/src/keyword_docs.rs
@ollie27

ollie27 commented Aug 18, 2020

Copy link
Copy Markdown
Contributor

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

jyn514 commented Aug 18, 2020

Copy link
Copy Markdown
Member

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

jyn514 commented Aug 18, 2020

Copy link
Copy Markdown
Member

@bors r+ rollup

@bors

bors commented Aug 18, 2020

Copy link
Copy Markdown
Collaborator

📌 Commit 431a465 has been approved by jyn514

@borsbors 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
@tmandry
Rollup merge ofrust-lang#75646- poliorcetics:intra-links-keywords, …
7e09c7e
…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
@tmandrytmandry mentioned this pull request Aug 18, 2020
Closed
tmandry added a commit to tmandry/rust that referenced this pull request Aug 18, 2020
@tmandry
Rollup merge ofrust-lang#75646- poliorcetics:intra-links-keywords, …
c915685
…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
@tmandrytmandry mentioned this pull request Aug 18, 2020
Closed
tmandry added a commit to tmandry/rust that referenced this pull request Aug 19, 2020
@tmandry
Rollup merge ofrust-lang#75646- poliorcetics:intra-links-keywords, …
96c8293
…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
@tmandrytmandry mentioned this pull request Aug 19, 2020
Closed
tmandry added a commit to tmandry/rust that referenced this pull request Aug 19, 2020
@tmandry
Rollup merge ofrust-lang#75646- poliorcetics:intra-links-keywords, …
81e8505
…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
@tmandrytmandry mentioned this pull request Aug 19, 2020
Closed
tmandry added a commit to tmandry/rust that referenced this pull request Aug 19, 2020
@tmandry
Rollup merge ofrust-lang#75646- poliorcetics:intra-links-keywords, …
9a305c0
…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
@tmandrytmandry mentioned this pull request Aug 19, 2020
Closed
@JohnTitorJohnTitor mentioned this pull request Aug 19, 2020
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Aug 19, 2020
@bors
Auto merge ofrust-lang#75692- JohnTitor:rollup-8gr04ah, r=JohnTitor
5b04bbf
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:masterAug 19, 2020
@poliorcetics
poliorcetics deleted the intra-links-keywords branch August 19, 2020 14:09
@jyn514jyn514 removed the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Aug 25, 2020
@cuvipercuviper added this to the 1.47.0 milestone May 2, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer
@jyn514jyn514jyn514 left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

@jyn514jyn514

Labels

A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsA-intra-doc-linksArea: Intra-doc links, the ability to link to items in docs by nameS-waiting-on-borsStatus: Waiting on bors to run and complete tests. Bors will change the label on completion.

Projects

None yet

Milestone

1.47.0

Development

Successfully merging this pull request may close these issues.

8 participants

@poliorcetics@rust-highfive@Mark-Simulacrum@ollie27@jyn514@bors@cuviper@rustbot