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.

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

docs: add link from zip to unzip #96038

Merged
merged 2 commits into from
Apr 16, 2022
Merged

docs: add link from zip to unzip #96038

merged 2 commits into from
Apr 16, 2022

Conversation

beyarkay
Copy link
Contributor

The docs for Iterator::unzip explain that it is kind of an inverse operation to Iterator::zip and guide the reader to the zip docs, but the zip docs don't let the user know that they can undo the zip operation with unzip. This change modifies the docs to help the user find unzip.

The docs for `Iterator::unzip` explain that it is kind of an inverse operation to `Iterator::zip` and guide the reader to the `zip` docs, but the `zip` docs don't let the user know that they can undo the `zip` operation with `unzip`. This change modifies the docs to help the user find `unzip`.
@rust-highfive
Copy link
Collaborator

Hey! It looks like you've submitted a new PR for the library teams!

If this PR contains changes to any rust-lang/rust public library APIs then please comment with r? rust-lang/libs-api @rustbot label +T-libs-api to request review from a libs-api team reviewer. If you're unsure where your change falls no worries, just leave it as is and the reviewer will take a look and make a decision to forward on if necessary.

Examples of T-libs-api changes:

  • a stabilization of a library feature
  • introducing new or changes existing unstable library APIs
  • changes to public documentation in ways that create new stability guarantees

@rustbot rustbot added the T-libs Relevant to the library team, which will review and decide on the PR/issue. label Apr 14, 2022
@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 @m-ou-se (or someone else) soon.

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 Apr 14, 2022
@m-ou-se
Copy link
Member

m-ou-se commented Apr 14, 2022

Thanks!

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Apr 14, 2022

📌 Commit f6d9577 has been approved by m-ou-se

@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 Apr 14, 2022
@m-ou-se
Copy link
Member

m-ou-se commented Apr 14, 2022

Oh, looks like the build is failing.

@bors r-

@bors bors 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-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Apr 14, 2022
Co-authored-by: Mara Bos <m-ou.se@m-ou.se>
@beyarkay
Copy link
Contributor Author

Ah that's annoying. Have removed the trailing whitespace.

@m-ou-se
Copy link
Member

m-ou-se commented Apr 14, 2022

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Apr 14, 2022

📌 Commit d73e328 has been approved by m-ou-se

@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-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Apr 14, 2022
@beyarkay
Copy link
Contributor Author

This is my first PR, not sure if I need to take action now that the Commit d73e328 has been approved by m-ou-se and All checks have passed?

@m-ou-se
Copy link
Member

m-ou-se commented Apr 14, 2022

Nope! The status is now S-waiting-on-bors, which means that bors will merge your commit(s) into a fork of this repository, test it on a huge amount of platforms, and push that back into this repository if it all passes. Those tests take a bit more than two hours, so there's a queue.

You can view the queue here: https://bors.rust-lang.org/queue/rust

I marked this PR as 'rollup', since I don't expect any failures or performance impact. That means that someone might 'roll it up' together with a bunch of other similar pull requests into a single patch that bors can test at once, to speed things up.

This PR will automatically get closed once bors merges it.

@beyarkay
Copy link
Contributor Author

Okay thanks so much! Really appreciate the explanations and welcoming attitude ☺️

Dylan-DPC added a commit to Dylan-DPC/rust that referenced this pull request Apr 14, 2022
docs: add link from zip to unzip

The docs for `Iterator::unzip` explain that it is kind of an inverse operation to `Iterator::zip` and guide the reader to the `zip` docs, but the `zip` docs don't let the user know that they can undo the `zip` operation with `unzip`. This change modifies the docs to help the user find `unzip`.
Dylan-DPC added a commit to Dylan-DPC/rust that referenced this pull request Apr 14, 2022
docs: add link from zip to unzip

The docs for `Iterator::unzip` explain that it is kind of an inverse operation to `Iterator::zip` and guide the reader to the `zip` docs, but the `zip` docs don't let the user know that they can undo the `zip` operation with `unzip`. This change modifies the docs to help the user find `unzip`.
Dylan-DPC added a commit to Dylan-DPC/rust that referenced this pull request Apr 14, 2022
docs: add link from zip to unzip

The docs for `Iterator::unzip` explain that it is kind of an inverse operation to `Iterator::zip` and guide the reader to the `zip` docs, but the `zip` docs don't let the user know that they can undo the `zip` operation with `unzip`. This change modifies the docs to help the user find `unzip`.
Dylan-DPC added a commit to Dylan-DPC/rust that referenced this pull request Apr 15, 2022
docs: add link from zip to unzip

The docs for `Iterator::unzip` explain that it is kind of an inverse operation to `Iterator::zip` and guide the reader to the `zip` docs, but the `zip` docs don't let the user know that they can undo the `zip` operation with `unzip`. This change modifies the docs to help the user find `unzip`.
RalfJung added a commit to RalfJung/rust that referenced this pull request Apr 15, 2022
docs: add link from zip to unzip

The docs for `Iterator::unzip` explain that it is kind of an inverse operation to `Iterator::zip` and guide the reader to the `zip` docs, but the `zip` docs don't let the user know that they can undo the `zip` operation with `unzip`. This change modifies the docs to help the user find `unzip`.
bors added a commit to rust-lang-ci/rust that referenced this pull request Apr 16, 2022
Rollup of 7 pull requests

Successful merges:

 - rust-lang#95887 (resolve: Create dummy bindings for all unresolved imports)
 - rust-lang#96023 (couple of clippy::perf fixes)
 - rust-lang#96035 (Update GitHub Actions actions/checkout Version v2 -> v3)
 - rust-lang#96038 (docs: add link from zip to unzip)
 - rust-lang#96047 (:arrow_up: rust-analyzer)
 - rust-lang#96059 (clarify doc(cfg) wording)
 - rust-lang#96081 (Make some `usize`-typed masks definitions agnostic to the size of `usize`)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit bd007ba into rust-lang:master Apr 16, 2022
@rustbot rustbot added this to the 1.62.0 milestone Apr 16, 2022
@m-ou-se
Copy link
Member

m-ou-se commented Apr 16, 2022

There were a few issues with the automated tests spuriously failing, so it took a few tries, but your PR is merged now! (Usually it takes less time.)

Your changes should be visible in the nightly documentation in about 7 hours from now, when the new nightly version is released.

@beyarkay
Copy link
Contributor Author

Thanks! Not sure my rust-fu is up to code changes just yet, but hopefully this won't be my last contribution :)

@beyarkay beyarkay deleted the patch-1 branch April 16, 2022 21:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-libs Relevant to the library team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants