Skip to content

Move to intra-doc links for wasi/ext/fs.rs, os_str_bytes.rs… - #75832

Merged
bors merged 7 commits into
rust-lang:masterfrom
kofls:intradoc-fix
Aug 30, 2020
Merged

Move to intra-doc links for wasi/ext/fs.rs, os_str_bytes.rs…#75832
bors merged 7 commits into
rust-lang:masterfrom
kofls:intradoc-fix

Conversation

@kofls

@koflskofls commented Aug 23, 2020

Copy link
Copy Markdown
Contributor

…, primitive_docs.rs & poison.rs

Partial fix for #75080

r? @jyn514

@rust-highfive

rust-highfive commented Aug 23, 2020

Copy link
Copy Markdown
Contributor

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @jyn514 (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

Please see the contribution instructions for more information.

@rust-highfiverust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Aug 23, 2020
kofls
kofls commented Aug 23, 2020
View reviewed changes
Comment threadlibrary/std/src/primitive_docs.rs Outdated
kofls
kofls commented Aug 23, 2020
View reviewed changes
Comment threadlibrary/std/src/primitive_docs.rs Outdated
jyn514
jyn514 reviewed Aug 23, 2020
View reviewed changes
Comment threadlibrary/std/src/primitive_docs.rs Outdated
Comment threadlibrary/std/src/primitive_docs.rs Outdated
Comment threadlibrary/std/src/sys_common/poison.rs Outdated
@jyn514jyn514 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 23, 2020
@kofls
kofls requested a review from jyn514August 23, 2020 15:47
jyn514
jyn514 reviewed Aug 23, 2020
View reviewed changes
Comment threadlibrary/std/src/primitive_docs.rs Outdated
@jyn514

jyn514 commented Aug 23, 2020

Copy link
Copy Markdown
Member

r=me once CI passes

@jyn514

jyn514 commented Aug 23, 2020

Copy link
Copy Markdown
Member

@bors r+ rollup

@bors

bors commented Aug 23, 2020

Copy link
Copy Markdown
Collaborator

📌 Commit bf7000ae18a5f40c3c8d887337c16e00fbf0a910 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 23, 2020
ollie27
ollie27 reviewed Aug 23, 2020
View reviewed changes
Comment threadlibrary/std/src/primitive_docs.rs Outdated
ollie27
ollie27 reviewed Aug 23, 2020
View reviewed changes
Comment threadlibrary/std/src/sys_common/poison.rs Outdated
@jyn514jyn514 mentioned this pull request Aug 23, 2020
Merged
JohnTitor added a commit to JohnTitor/rust that referenced this pull request Aug 24, 2020
@JohnTitor
Rollup merge ofrust-lang#75855- jyn514:no-cfg-doc, r=ollie27
30e7430
Use allow(unused_imports) instead of cfg(doc) for imports used only for intra-doc links
This prevents links from breaking when items are re-exported in a
different crate and the original isn't being documented.
Spotted in rust-lang#75832 (comment) (thanks ollie!)
r? @ollie27
bors added a commit to rust-lang-ci/rust that referenced this pull request Aug 24, 2020
@bors
Auto merge ofrust-lang#75855- jyn514:no-cfg-doc, r=ollie27
d795eb4
Use allow(unused_imports) instead of cfg(doc) for imports used only for intra-doc links
This prevents links from breaking when items are re-exported in a
different crate and the original isn't being documented.
Spotted in rust-lang#75832 (comment) (thanks ollie!)
r? @ollie27
@jyn514jyn514 removed the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Aug 25, 2020
@jyn514jyn514 mentioned this pull request Aug 25, 2020
Merged
@kofls

kofls commented Aug 26, 2020

Copy link
Copy Markdown
ContributorAuthor

@jyn514 I had to rebase and change f32 -> prim@f32 and u32 -> prim@u32 to fix some merge conflicts.

@jyn514

jyn514 commented Aug 26, 2020

Copy link
Copy Markdown
Member

Changes look fine to me.

@jyn514

jyn514 commented Aug 29, 2020

Copy link
Copy Markdown
Member

@bors r+ rollup

Looks like it silently gets removed from the queue if you push additional commits 🤦

@bors

bors commented Aug 29, 2020

Copy link
Copy Markdown
Collaborator

📌 Commit 7569cf9 has been approved by jyn514

@Dylan-DPC-zzDylan-DPC-zz mentioned this pull request Aug 29, 2020
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Aug 30, 2020
@bors
Auto merge ofrust-lang#76090- Dylan-DPC:rollup-eksndcr, r=Dylan-DPC
62850d8
Rollup of 14 pull requests
Successful merges:
- rust-lang#75832 (Move to intra-doc links for wasi/ext/fs.rs, os_str_bytes.rs…)
- rust-lang#75852 (Switch to intra-doc links in `core::hash`)
- rust-lang#75874 (Shorten liballoc doc intra link while readable)
- rust-lang#75881 (Expand rustdoc theme chooser x padding)
- rust-lang#75885 (Fix another clashing_extern_declarations false positive.)
- rust-lang#75892 (Fix typo in TLS Model in Unstable Book)
- rust-lang#75910 (Add test for issue rust-lang#27130)
- rust-lang#75917 (Move to intra doc links for core::ptr::non_null)
- rust-lang#75975 (Allow --bess ing expect-tests in tools)
- rust-lang#75990 (Add __fastfail for Windows on arm/aarch64)
- rust-lang#76015 (Fix loading pretty-printers in rust-lldb script)
- rust-lang#76022 (Clean up rustdoc front-end source code)
- rust-lang#76029 (Move to intra-doc links for library/core/src/sync/atomic.rs)
- rust-lang#76057 (Move retokenize hack to save_analysis)
Failed merges:
r? @ghost
@bors
bors merged commit 027b2f1 into rust-lang:masterAug 30, 2020
@kofls
kofls deleted the intradoc-fix branch August 30, 2020 07:41
@cuvipercuviper added this to the 1.48.0 milestone May 2, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

2 more reviewers
@ollie27ollie27ollie27 left review comments
@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.48.0

Development

Successfully merging this pull request may close these issues.

6 participants

@kofls@rust-highfive@jyn514@bors@ollie27@cuviper