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.

Sign up for GitHub

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

Jump to bottom

Move to intra-doc links for /library/core/src/hint.rs #75423

Merged
merged 3 commits into from
Aug 16, 2020
Merged

Move to intra-doc links for /library/core/src/hint.rs #75423

merged 3 commits into from
Aug 16, 2020

Conversation

denisvasilik
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 11, 2020
@rust-highfive
Copy link
Collaborator

r? @dtolnay

(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 11, 2020
jyn514
jyn514 reviewed Aug 12, 2020
View reviewed changes
library/core/src/hint.rs Outdated Show resolved Hide resolved
library/core/src/hint.rs
@@ -61,7 +61,7 @@ pub const unsafe fn unreachable_unchecked() -> ! {
/// **Note**: On platforms that do not support receiving spin-loop hints this function does not
/// do anything at all.
///
/// [`core::sync::atomic::spin_loop_hint`]: ../sync/atomic/fn.spin_loop_hint.html
/// [`core::sync::atomic::spin_loop_hint`]: crate::sync::atomic::spin_loop_hint
Copy link
Member

Choose a reason for hiding this comment

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

This would be easier if #73473 were fixed :(

@jyn514 jyn514 assigned jyn514 and unassigned dtolnay Aug 12, 2020
@denisvasilik
Remove intra-doc link as it resolves without reference link
4c5896f 
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
@denisvasilik
Copy link
Contributor Author

When I try to replace [std::convert::identity]: https://doc.rust-lang.org/core/convert/fn.identity.html by [std::convert::identity]: crate::convert::identity I don't get a warning when checking links. Unfortunately, it breaks the build, because of an unresolved link. So for now I reverted this change. Do you know whether this intra-doc link should work?

@jyn514
Copy link
Member

jyn514 commented Aug 12, 2020

It's breaking on a re-export, which is #65983, fixed a couple of weeks ago. The error happens because CI tests with --stage 0 (#75368 (comment)). So that link can't be fixed for another couple weeks until the beta release.

@denisvasilik
Copy link
Contributor Author

Okay let's than wait until this is fixed and I'll try another attempt with this link.

@jyn514 jyn514 added S-blocked Status: Marked as blocked ❌ on something else such as an RFC or other implementation work. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Aug 14, 2020
@dtolnay
Copy link
Member

dtolnay commented Aug 16, 2020

@bors r+

@bors
Copy link
Contributor

bors commented Aug 16, 2020

📌 Commit 4c5896f has been approved by dtolnay

@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-blocked Status: Marked as blocked ❌ on something else such as an RFC or other implementation work. labels Aug 16, 2020
@dtolnay
Copy link
Member

dtolnay commented Aug 16, 2020

It sounds like the two changes here (unreachable and spin_loop_hint) are fine, and we can follow up on the convert::identity link separately.

Dylan-DPC-zz pushed a commit to Dylan-DPC-zz/rust that referenced this pull request Aug 16, 2020
@Dylan-DPC
Rollup merge of rust-lang#75423 - denisvasilik:intra-doc-links-core-h…
58a0860 
…int, r=dtolnay

Move to intra-doc links for /library/core/src/hint.rs

Helps with rust-lang#75080.

@rustbot modify labels: T-doc, A-intra-doc-links, T-rustdoc
@Dylan-DPC-zz Dylan-DPC-zz mentioned this pull request Aug 16, 2020
Closed
@tmandry tmandry mentioned this pull request Aug 16, 2020
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Aug 16, 2020
@bors
Auto merge of rust-lang#75609 - tmandry:rollup-yrcmgke, r=tmandry
7e6d6e5 
Rollup of 10 pull requests

Successful merges:

 - rust-lang#74204 (Don't visit foreign function bodies when lowering ast to hir)
 - rust-lang#74314 (rustc_typeck: construct {Closure,Generator}Substs more directly.)
 - rust-lang#74346 (Use LocalDefId instead of HirId for reachable_set elements.)
 - rust-lang#74399 (Move DelaySpanBugEmitted to ty::context)
 - rust-lang#75177 (Add regression test for issue-66768)
 - rust-lang#75223 (Add #[track_caller] to `Session::delay_span_bug`)
 - rust-lang#75423 (Move to intra-doc links for /library/core/src/hint.rs)
 - rust-lang#75485 (pin docs: add some forward references)
 - rust-lang#75569 (Bump minor version of emsdk to 1.38.47)
 - rust-lang#75596 (Switch to intra-doc links in /sys/windows/ext/{ffi,fs,process}.rs)

Failed merges:

r? @ghost
@bors bors merged commit 18e3799 into rust-lang:master Aug 16, 2020
@jyn514 jyn514 mentioned this pull request Aug 18, 2020
Closed
@jyn514 jyn514 removed the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Aug 25, 2020
@dtolnay dtolnay self-assigned this Mar 24, 2024
@cuviper cuviper added this to the 1.47.0 milestone May 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jyn514 jyn514 jyn514 left review comments

@dtolnay dtolnay dtolnay approved these changes

Assignees

@dtolnay dtolnay

@jyn514 jyn514

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
Milestone
1.47.0
Development

Successfully merging this pull request may close these issues.
7 participants
@denisvasilik @rust-highfive @jyn514 @dtolnay @bors @cuviper @rustbot