Skip to content

Use more intra-doc-links in core::fmt #75853

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

Jump to bottom
Merged
merged 1 commit into from
Oct 5, 2020
Merged

Use more intra-doc-links in core::fmt #75853

merged 1 commit into from
Oct 5, 2020

Conversation

LeSeulArtichaut
Copy link
Contributor

@LeSeulArtichaut LeSeulArtichaut commented Aug 23, 2020 •
edited
Loading

This is a follow-up to #75819, which encountered some broken links due to #75176, so this PR contains the links that are blocked on #75176.

r? @jyn514

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Aug 23, 2020
@LeSeulArtichaut LeSeulArtichaut added S-blocked Status: 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 23, 2020
@jyn514 jyn514 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 labels Aug 23, 2020
@jyn514 jyn514 mentioned this pull request Aug 25, 2020
Merged
@bors
Copy link
Collaborator

bors commented Sep 3, 2020

☔ The latest upstream changes (presumably #73819) made this pull request unmergeable. Please resolve the merge conflicts.

@jyn514
Copy link
Member

jyn514 commented Sep 3, 2020

This can be merged once you rebase :) assuming that --stage 0 doesn't error which it might. If so it will have to wait another 5 weeks :/

@jyn514 jyn514 added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-blocked Status: Blocked on something else such as an RFC or other implementation work. labels Sep 3, 2020
@LeSeulArtichaut LeSeulArtichaut added S-blocked Status: Blocked on something else such as an RFC or other implementation work. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Sep 9, 2020
@camelid
Copy link
Member

camelid commented Oct 4, 2020

triage: Is this still blocked?

camelid
camelid requested changes Oct 4, 2020
View reviewed changes
Copy link
Member

@camelid camelid left a comment

Choose a reason for hiding this comment

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

It seems like all of these are auto-imported, which might resolve the blockage?

library/core/src/fmt/mod.rs
@@ -102,7 +102,7 @@ pub struct Error;
/// library. The [`write!`] macro accepts an instance of [`io::Write`], and the
/// [`io::Write`] trait is favored over implementing this trait.
///
/// [`write!`]: ../../std/macro.write.html
/// [`write!`]: crate::write!
Copy link
Member

Choose a reason for hiding this comment

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

Isn't this auto-imported?

Suggested change
/// [`write!`]: crate::write!

library/core/src/fmt/mod.rs
@@ -1058,7 +1058,7 @@ pub trait UpperExp {
/// assert_eq!(output, "Hello world!");
/// ```
///
/// [`write!`]: ../../std/macro.write.html
/// [`write!`]: crate::write!
Copy link
Member

Choose a reason for hiding this comment

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

Same here.

Suggested change
/// [`write!`]: crate::write!

library/core/src/fmt/mod.rs
Comment on lines +1889 to 1890
/// [`format_args!`]: crate::format_args
///
Copy link
Member

Choose a reason for hiding this comment

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

This too:

Suggested change
/// [`format_args!`]: crate::format_args
///

@jyn514
Copy link
Member

jyn514 commented Oct 4, 2020

This should be ready to go after a rebase :)

@jyn514 jyn514 added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-blocked Status: Blocked on something else such as an RFC or other implementation work. labels Oct 4, 2020
@LeSeulArtichaut
Copy link
Contributor Author

Rebased

jyn514
jyn514 approved these changes Oct 4, 2020
View reviewed changes
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.

It works 🎉

@jyn514
Copy link
Member

jyn514 commented Oct 4, 2020

@bors r+ rollup

@bors
Copy link
Collaborator

bors commented Oct 4, 2020

📌 Commit 17d3c0a 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-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Oct 4, 2020
@camelid
Copy link
Member

camelid commented Oct 4, 2020

Aren't all these links unnecessary though, since they're in the prelude?

@jyn514
Copy link
Member

jyn514 commented Oct 5, 2020

Sure, we can fix them in a follow-up. I mostly want to finally get this merged 😆

@Dylan-DPC-zz Dylan-DPC-zz mentioned this pull request Oct 5, 2020
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Oct 5, 2020
@bors
Auto merge of rust-lang#77557 - Dylan-DPC:rollup-aib9ptp, r=Dylan-DPC
efbaa41 
Rollup of 11 pull requests

Successful merges:

 - rust-lang#75853 (Use more intra-doc-links in `core::fmt`)
 - rust-lang#75928 (Remove trait_selection error message in specific case)
 - rust-lang#76329 (Add check for doc alias attribute at crate level)
 - rust-lang#77219 (core::global_allocator docs link to std::alloc::GlobalAlloc)
 - rust-lang#77395 (BTreeMap: admit the existence of leaf edges in comments)
 - rust-lang#77407 (Improve build-manifest to work with the improved promote-release)
 - rust-lang#77426 (Include scope id in SocketAddrV6::Display)
 - rust-lang#77439 (Fix missing diagnostic span for `impl Trait` with const generics, and add various tests for `min_const_generics` and `const_generics`)
 - rust-lang#77471 (BTreeMap: refactoring around edges, missed spots)
 - rust-lang#77512 (Allow `Abort` terminators in all const-contexts)
 - rust-lang#77514 (Replace some once(x).chain(once(y)) with [x, y] IntoIter)

Failed merges:

r? `@ghost`
@bors bors merged commit 6c9e857 into rust-lang:master Oct 5, 2020
@rustbot rustbot added this to the 1.49.0 milestone Oct 5, 2020
@LeSeulArtichaut LeSeulArtichaut deleted the core-intra-docs-3 branch February 18, 2021 20:27
# for free to join this conversation on GitHub. Already have an account? # to comment
Reviewers

@camelid camelid camelid requested changes

@jyn514 jyn514 jyn514 approved these changes

Assignees

@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.49.0
Development

Successfully merging this pull request may close these issues.
6 participants
@LeSeulArtichaut @bors @jyn514 @camelid @rust-highfive @rustbot