Skip to content

Simplify iter sources doc and links - #76816

Closed
pickfire wants to merge 3 commits into
rust-lang:masterfrom
pickfire:patch-4
Closed

Simplify iter sources doc and links#76816
pickfire wants to merge 3 commits into
rust-lang:masterfrom
pickfire:patch-4

Conversation

@pickfire

@pickfirepickfire commented Sep 17, 2020

Copy link
Copy Markdown
Contributor

No description provided.

@rust-highfive

rust-highfive commented Sep 17, 2020

Copy link
Copy Markdown
Contributor

r? @dtolnay

(rust_highfive has picked a reviewer for you, use r? to override)

@rust-highfiverust-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

@jyn514jyn514 left a comment

Copy link
Copy Markdown
Member

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.

Comment threadlibrary/core/src/iter/sources.rs Outdated
Comment threadlibrary/core/src/iter/sources.rs
Comment threadlibrary/core/src/iter/sources.rs Outdated
/// applying the provided closure `F: FnMut() -> A`.
///
/// This `struct` is created by the [`repeat_with`] function.
/// This `struct` is created by [`repeat_with`].

@jyn514jyn514Sep 17, 2020

Copy link
Copy Markdown
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

@jyn514jyn514 added T-libs-api [DEPRECATED; DO NOT USE] 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
@pickfirepickfire mentioned this pull request Sep 18, 2020
Merged
@dtolnay

dtolnay commented Sep 19, 2020

Copy link
Copy Markdown
Member

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

@rust-highfiverust-highfive assigned jyn514 and unassigned dtolnaySep 19, 2020
dtolnay
dtolnay reviewed Sep 19, 2020
View reviewed changes

@dtolnaydtolnay left a comment

Copy link
Copy Markdown
Member

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".

@jyn514jyn514 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
Comment threadlibrary/core/src/iter/sources.rs
/// applying the provided closure `F: FnMut() -> A`.
///
/// This `struct` is created by the [`repeat_with`] function.
/// This `struct` is created by [`iter::repeat_with`].

@jyn514jyn514Sep 20, 2020

Copy link
Copy Markdown
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

@jyn514jyn514 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

pickfire commented Sep 21, 2020

Copy link
Copy Markdown
ContributorAuthor

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

@pickfire
pickfire deleted the patch-4 branch September 21, 2020 01:18
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@dtolnaydtolnaydtolnay left review comments
+1 more reviewer
@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-authorStatus: This is awaiting some action (such as code changes or more information) from the author.T-libs-api[DEPRECATED; DO NOT USE]

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@pickfire@rust-highfive@dtolnay@jyn514