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

Clarify that VecDeque::swap can panic #44114

Merged
merged 1 commit into from Aug 28, 2017
Merged

Clarify that VecDeque::swap can panic #44114

merged 1 commit into from Aug 28, 2017

Conversation

daboross
Copy link
Contributor

The previous documentation mentioned this, but ambiguously used the term "fail".

This clarifies that the function will panic if the index is out of bounds, instead of silently failing and not doing anything.

If there's anything else I can do to improve this PR, I'd be happy to do so! Just saw this when reading through the docs in passing - it was slightly unclear what "fail" meant.

The previous documentation mentioned this, but ambiguously used the term "fail".

This clarifies that the function will panic if the index is out of bounds, instead of silently failing and not doing anything.
@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 @dtolnay (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.

@dtolnay
Copy link
Member

dtolnay commented Aug 27, 2017

Looks good to me. Thank you!

@bors r+

@bors
Copy link
Contributor

bors commented Aug 27, 2017

📌 Commit f1b91f4 has been approved by dtolnay

@bors
Copy link
Contributor

bors commented Aug 27, 2017

⌛ Testing commit f1b91f4 with merge 8460c81f910dc218cfa56549775ebbd5ad101860...

@bors
Copy link
Contributor

bors commented Aug 27, 2017

💔 Test failed - status-travis

@kennytm
Copy link
Member

kennytm commented Aug 28, 2017

@bors retry rollup

armhf-gnu failed while building LLVM.

[00:03:44] -- Constructing LLVMBuild project information
[00:03:44] -- Targeting X86
[00:03:44] -- Targeting ARM

No output has been received in the last 30m0s, this potentially indicates a stalled build or something wrong with the build itself.

Check the details on how to adjust your build configuration on: https://docs.travis-ci.com/user/common-build-problems/#Build-times-out-because-no-output-was-received

The build has been terminated

@bors
Copy link
Contributor

bors commented Aug 28, 2017

⌛ Testing commit f1b91f4 with merge 5caca6f...

bors added a commit that referenced this pull request Aug 28, 2017
Clarify that VecDeque::swap can panic

The previous documentation mentioned this, but ambiguously used the term "fail".

This clarifies that the function will panic if the index is out of bounds, instead of silently failing and not doing anything.

If there's anything else I can do to improve this PR, I'd be happy to do so! Just saw this when reading through the docs in passing - it was slightly unclear what "fail" meant.
@carols10cents carols10cents added the S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. label Aug 28, 2017
@bors
Copy link
Contributor

bors commented Aug 28, 2017

☀️ Test successful - status-appveyor, status-travis
Approved by: dtolnay
Pushing 5caca6f to master...

@bors bors merged commit f1b91f4 into rust-lang:master Aug 28, 2017
@daboross daboross deleted the patch-1 branch January 3, 2018 02:15
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.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants