Skip to content

Move to intra-doc links for library/core/src/iter/traits/iterator.rs #76238

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 6 commits into from
Sep 3, 2020
Merged

Move to intra-doc links for library/core/src/iter/traits/iterator.rs #76238

merged 6 commits into from
Sep 3, 2020

Conversation

denisvasilik
Copy link
Contributor

Helps with #75080.

@jyn514 We're almost finished with this issue. Thanks for mentoring. If you have other topics to work on just let me know, I will be around in Discord.

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

Known issues:

@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 labels Sep 2, 2020
@rust-highfive
Copy link
Contributor

r? @sfackler

(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 Sep 2, 2020
@jyn514
Copy link
Member

jyn514 commented Sep 2, 2020

r? @jyn514

@rust-highfive rust-highfive assigned jyn514 and unassigned sfackler Sep 2, 2020
jyn514
jyn514 reviewed Sep 2, 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.

Thanks so much for all your hard work! I don't have other issues in mind just at the moment, but I'm sure @Dylan-DPC or someone else will have suggestions - #73904 might be a good fit.

library/core/src/iter/traits/iterator.rs Outdated
@@ -1350,8 +1342,6 @@ pub trait Iterator {
/// [`Some(T)`] again. `fuse()` adapts an iterator, ensuring that after a
/// [`None`] is given, it will always return [`None`] forever.
///
/// [`Some(T)`]: Some
Copy link
Member

Choose a reason for hiding this comment

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

Broken link, needs to be re-added.

Copy link
Member

Choose a reason for hiding this comment

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

This one is still missing a link.

@jyn514 jyn514 changed the title # Move to intra-doc links for library/core/src/iter/traits/iterator.rs Move to intra-doc links for library/core/src/iter/traits/iterator.rs Sep 2, 2020
@jyn514
Copy link
Member

jyn514 commented Sep 2, 2020 

 error: public documentation for `Iterator` links to private item `self`
  --> library/core/src/iter/traits/iterator.rs:25:35
   |
25 | /// [module-level documentation]: self
   |                                   ^^^^ this item is private
   |
   = note: `-D broken-intra-doc-links` implied by `-D warnings`
   = note: this link will resolve properly if you pass `--document-private-items`

error: unresolved link to `once`
   --> library/core/src/iter/traits/iterator.rs:400:10
    |
400 |     /// [`once`] is commonly used to adapt a single value into a chain of
    |          ^^^^^^ unresolved link
    |
    = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`

Oh I see, this is in crate::iter::traits, not in crate::iter. It's just re-exported. Yeah, reverting to the longer links is fine then.

@jyn514
Copy link
Member

jyn514 commented Sep 2, 2020

@bors r+ rollup

Thanks again!

@bors
Copy link
Collaborator

bors commented Sep 2, 2020

📌 Commit 89e7fb3 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 Sep 2, 2020
@Dylan-DPC-zz Dylan-DPC-zz mentioned this pull request Sep 3, 2020
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Sep 3, 2020
@bors
Auto merge of rust-lang#76265 - Dylan-DPC:rollup-j3i509l, r=Dylan-DPC
4f66117 
Rollup of 12 pull requests

Successful merges:

 - rust-lang#75150 (Add a note for Ipv4Addr::to_ipv6_compatible)
 - rust-lang#76120 (Add `[T; N]::as_[mut_]slice`)
 - rust-lang#76142 (Make all methods of `std::net::Ipv4Addr` const)
 - rust-lang#76164 (Link to slice pattern in array docs)
 - rust-lang#76167 (Replace MinGW library hack with heuristic controlling link mode)
 - rust-lang#76204 (Rename and expose LoopState as ControlFlow)
 - rust-lang#76238 (Move to intra-doc links for library/core/src/iter/traits/iterator.rs)
 - rust-lang#76242 (Read: adjust a FIXME reference)
 - rust-lang#76243 (Fix typos in vec try_reserve(_exact) docs)
 - rust-lang#76245 (inliner: Avoid query cycles when optimizing generators)
 - rust-lang#76255 (Update books)
 - rust-lang#76261 (Use intra-doc links in `core::marker`)

Failed merges:

r? @ghost
@bors bors merged commit 4918ed9 into rust-lang:master Sep 3, 2020
@cuviper cuviper added this to the 1.48.0 milestone Nov 16, 2023
# for free to join this conversation on GitHub. Already have an account? # to comment
Reviewers

@jyn514 jyn514 jyn514 left review comments

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.48.0
Development

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