Skip to content

Simplify iter sources doc and links #76816

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
Closed
wants to merge 3 commits into from
Closed

Simplify iter sources doc and links #76816

wants to merge 3 commits into from

Conversation

pickfire
Copy link
Contributor

No description provided.

@rust-highfive
Copy link
Contributor

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 Sep 17, 2020
jyn514
jyn514 reviewed Sep 17, 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.

Same nits for the other changes.

library/core/src/iter/sources.rs Outdated
@@ -102,10 +101,8 @@ pub fn repeat<T: Clone>(elt: T) -> Repeat<T> {
/// An iterator that repeats elements of type `A` endlessly by
/// applying the provided closure `F: FnMut() -> A`.
///
/// This `struct` is created by the [`repeat_with`] function.
/// This `struct` is created by [`repeat_with`].
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
/// This `struct` is created by [`repeat_with`].
/// This `struct` is created by [`repeat_with()`].

and same newline nit as above

@jyn514 jyn514 added T-libs-api Relevant to the library API team, which will review and decide on the PR/issue. A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Sep 17, 2020
@pickfire pickfire mentioned this pull request Sep 18, 2020
Merged
@dtolnay
Copy link
Member

dtolnay commented Sep 19, 2020

Reassigning r? @jyn514 for consistent style since you are reviewing #76867.

@rust-highfive rust-highfive assigned jyn514 and unassigned dtolnay Sep 19, 2020
dtolnay
dtolnay reviewed Sep 19, 2020
View reviewed changes
Copy link
Member

@dtolnay dtolnay left a comment

Choose a reason for hiding this comment

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

I think I prefer the original wording before this PR. "created by once" is less clear to me than "created by the once function" or "created by iter::once".

@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-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Sep 19, 2020
jyn514
jyn514 reviewed Sep 20, 2020
View reviewed changes
library/core/src/iter/sources.rs
@@ -102,10 +101,8 @@ pub fn repeat<T: Clone>(elt: T) -> Repeat<T> {
/// An iterator that repeats elements of type `A` endlessly by
/// applying the provided closure `F: FnMut() -> A`.
///
/// This `struct` is created by the [`repeat_with`] function.
/// This `struct` is created by [`iter::repeat_with`].
Copy link
Member

Choose a reason for hiding this comment

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

All these links will be broken, you need to add reference links:

[`iter::repeat_with`]: repeat_with

@jyn514 jyn514 added the A-intra-doc-links Area: Intra-doc links, the ability to link to items in docs by name label Sep 20, 2020
@pickfire
Copy link
Contributor Author

@poliorcetics is working on this with the same file as this, I believe I should let him continue.

@pickfire pickfire closed this Sep 21, 2020
@pickfire pickfire deleted the patch-4 branch September 21, 2020 01:18
# for free to join this conversation on GitHub. Already have an account? # to comment
Reviewers

@dtolnay dtolnay dtolnay left review comments

@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-author Status: This is awaiting some action (such as code changes or more information) from the author. T-libs-api Relevant to the library API team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@pickfire @rust-highfive @dtolnay @jyn514