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

Small improvements to the documentation of VecDeque. #47595

Merged
merged 2 commits into from
Jan 22, 2018
Merged

Small improvements to the documentation of VecDeque. #47595

merged 2 commits into from
Jan 22, 2018

Conversation

PieterPenninckx
Copy link
Contributor

Some small improvements to the documentation of VecDeque.

@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 @KodrAus (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.

shepmaster
shepmaster reviewed Jan 20, 2018
View reviewed changes
src/liballoc/vec_deque.rs Outdated
///
/// Note that the capacity of `self` does not change.
///
/// Element at index 0 is the front of the queue.
///
/// # Panics
///
/// Panics if `at > len`
/// Panics if `at` is out of bounds.
Copy link
Member

Choose a reason for hiding this comment

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

This seems less descriptive than it was previously. at is a usize, so we know it cannot be negative, but it's not immediately obvious what the "bounds" would be.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Nice catch, @shepmaster, especially since at == len is allowed.
I wanted to get rid of the un-introduced value len, but in the end, it seems best to just keep it, so I have reverted the change.

@shepmaster
Copy link
Member

I like that you unified "buffer", "collection", and "list"!

@shepmaster shepmaster added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jan 20, 2018
@KodrAus
Copy link
Contributor

KodrAus commented Jan 21, 2018

Thanks @PieterPenninckx! Besides @shepmaster's comment about the panic section on split_off this looks good to me!

KodrAus
KodrAus approved these changes Jan 21, 2018
View reviewed changes
Copy link
Contributor

@KodrAus KodrAus left a comment

Choose a reason for hiding this comment

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

This looks good to me! Thanks again @PieterPenninckx

@KodrAus
Copy link
Contributor

KodrAus commented Jan 21, 2018

@homu r+ rollup

@shepmaster
Copy link
Member

@bors r+ rollup r=KodrAus

@bors
Copy link
Contributor

bors commented Jan 21, 2018

📌 Commit ea814b8 has been approved by KodrAus

@bors
Copy link
Contributor

bors commented Jan 21, 2018

📌 Commit ea814b8 has been approved by shepmaster

GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request Jan 21, 2018
@GuillaumeGomez
Rollup merge of rust-lang#47595 - PieterPenninckx:master, r=shepmaster
c354bb8 
Small improvements to the documentation of VecDeque.

Some small improvements to the documentation of `VecDeque`.
@GuillaumeGomez GuillaumeGomez mentioned this pull request Jan 21, 2018
Merged
bors added a commit that referenced this pull request Jan 21, 2018
@bors
Auto merge of #47644 - GuillaumeGomez:rollup, r=GuillaumeGomez
ff2a7c8 
Rollup of 9 pull requests

- Successful merges: #47247, #47334, #47512, #47582, #47595, #47625, #47632, #47633, #47637
- Failed merges:
@KodrAus
Copy link
Contributor

KodrAus commented Jan 21, 2018

Whoops... Wrong buildbot :)

@bors bors merged commit ea814b8 into rust-lang:master Jan 22, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@shepmaster shepmaster shepmaster left review comments

@KodrAus KodrAus KodrAus approved these changes

Assignees

@KodrAus KodrAus

Labels
S-waiting-on-review Status: Awaiting review from the assignee but also interested parties.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@PieterPenninckx @rust-highfive @shepmaster @KodrAus @bors