Skip to content

Improve wording of flatten() docs #79925

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
Merged
merged 1 commit into from
Dec 11, 2020
Merged

Improve wording of flatten() docs #79925

merged 1 commit into from
Dec 11, 2020

Conversation

camelid
Copy link
Member

@camelid camelid commented Dec 11, 2020

No description provided.

@camelid camelid added A-iterators Area: Iterators A-result-option Area: Result and Option combinators A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools labels Dec 11, 2020
@rust-highfive
Copy link
Contributor

r? @Mark-Simulacrum

(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 Dec 11, 2020
@scottmcm
Copy link
Member

r? @scottmcm
@bors r+ rollup

@bors
Copy link
Collaborator

bors commented Dec 11, 2020

📌 Commit 97cd55e has been approved by scottmcm

@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 Dec 11, 2020
pickfire
pickfire reviewed Dec 11, 2020
View reviewed changes
library/core/src/iter/traits/iterator.rs
@@ -1332,7 +1332,7 @@ pub trait Iterator {
/// assert_eq!(merged, "alphabetagamma");
/// ```
///
/// Flattening once only removes one level of nesting:
/// Flattening only removes one level of nesting at a time:
Copy link
Contributor

@pickfire pickfire Dec 11, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

Suggested change
/// Flattening only removes one level of nesting at a time:
/// Flattening only removes one level of nesting once:

"at a time" is not clear that it happened once, feels like a play a words, people may not notice it if not careful. Oh, after reading it I find it being extra, we can even remove "at a time" or "once".

Flattening only removes one level of nesting

I think would be clear enough.

@bors
Copy link
Collaborator

bors commented Dec 11, 2020

⌛ Testing commit 97cd55e with merge 2225ee1...

@bors
Copy link
Collaborator

bors commented Dec 11, 2020

☀️ Test successful - checks-actions
Approved by: scottmcm
Pushing 2225ee1 to master...

@bors bors added the merged-by-bors This PR was explicitly merged by bors. label Dec 11, 2020
@bors bors merged commit 2225ee1 into rust-lang:master Dec 11, 2020
@rustbot rustbot added this to the 1.50.0 milestone Dec 11, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
1 more reviewer

@pickfire pickfire pickfire left review comments

Reviewers whose approvals may not affect merge requirements
Assignees

@scottmcm scottmcm

Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools A-iterators Area: Iterators A-result-option Area: Result and Option combinators merged-by-bors This PR was explicitly merged by bors. 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.50.0
Development

Successfully merging this pull request may close these issues.
7 participants
@camelid @rust-highfive @scottmcm @bors @pickfire @Mark-Simulacrum @rustbot