Skip to content
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

Improved std::iter::Chain documentation #66019

Merged
merged 1 commit into from
Nov 5, 2019
Merged

Improved std::iter::Chain documentation #66019

merged 1 commit into from
Nov 5, 2019

Conversation

olegnn
Copy link
Contributor

@olegnn olegnn commented Nov 1, 2019

Replaces strings two iterators by links two iterators in std::iter::Chain documentation.

I didn't find any meaning of strings which can be evaluated as links or joins.

I don't think that std::iter:Chain works as a stringer or plays billiards. (https://www.lexico.com/en/definition/string).

@rust-highfive
Copy link
Collaborator

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @Mark-Simulacrum (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

Please see the contribution instructions for more information.

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Nov 1, 2019
@jonas-schievink
Copy link
Contributor

I didn't find any meaning of strings which can be evaluated as links or joins.

https://www.merriam-webster.com/dictionary/string%20together

@jonas-schievink
Copy link
Contributor

(not to imply that the wording here couldn't use some improvement, of course)

@olegnn
Copy link
Contributor Author

olegnn commented Nov 1, 2019

First meaning - to combine (different things) into something that is complete, useful, etc.. I don't think it's applicable to what this method really does because each iterator is complete and useful already.
Second meaning - to create (something) by putting different things together still much less understandable than links or joins because of different things (are two iterators different things really?) and to create (something) (it just chains two iterators).
Moreover ther's no such phrase in Oxford dictionary, so it's much less known.

@olegnn olegnn changed the title Fixed std::iter::Chain documentation Improved std::iter::Chain documentation Nov 1, 2019
@Mark-Simulacrum
Copy link
Member

Seems like this is fine to change, I agree the new wording is slightly clearer. Thanks!

@bors r+ rollup=always

@bors
Copy link
Contributor

bors commented Nov 4, 2019

📌 Commit 595d818 has been approved by Mark-Simulacrum

@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 Nov 4, 2019
pietroalbini added a commit to pietroalbini/rust that referenced this pull request Nov 5, 2019
@pietroalbini
Rollup merge of rust-lang#66019 - olegnn:fixed_std_iter_chain_docs, r…
c25975d 
…=Mark-Simulacrum

Improved std::iter::Chain documentation

Replaces `strings two iterators` by `links two iterators` in `std::iter::Chain` documentation.

I didn't find any meaning of `strings` which can be evaluated as `links` or `joins`.

I don't think that `std::iter:Chain` works as a stringer or plays billiards. (https://www.lexico.com/en/definition/string).
@pietroalbini pietroalbini mentioned this pull request Nov 5, 2019
Merged
bors added a commit that referenced this pull request Nov 5, 2019
@bors
Auto merge of #66109 - pietroalbini:rollup-2npidna, r=pietroalbini
d1fff4a 
Rollup of 10 pull requests

Successful merges:

 - #65136 (Update codegen option documentation.)
 - #65574 (docs: improve disclaimer regarding LinkedList)
 - #65720 (Add FFI bindings for LLVM's Module::getInstructionCount())
 - #65905 ([doc] fixes for unix/vxworks `OpenOptionsExt::mode`)
 - #65962 (Fix logic in example.)
 - #66019 (Improved std::iter::Chain documentation)
 - #66038 (doc(str): show example of chars().count() under len())
 - #66042 (Suggest correct code when encountering an incorrect trait bound referencing the current trait)
 - #66073 (Do not needlessly write-lock)
 - #66096 (Add a failing UI test for multiple loops of all kinds in a `const`)

Failed merges:

r? @ghost
@bors bors merged commit 595d818 into rust-lang:master Nov 5, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@Mark-Simulacrum Mark-Simulacrum

Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@olegnn @rust-highfive @jonas-schievink @Mark-Simulacrum @bors