Small improvements to the documentation of VecDeque.#47595
Small improvements to the documentation of VecDeque.#47595bors merged 2 commits intorust-lang:masterfrom
Conversation
|
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. |
src/liballoc/vec_deque.rs
Outdated
| /// # Panics | ||
| /// | ||
| /// Panics if `at > len` | ||
| /// Panics if `at` is out of bounds. |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
|
I like that you unified "buffer", "collection", and "list"! |
|
Thanks @PieterPenninckx! Besides @shepmaster's comment about the panic section on |
KodrAus
left a comment
There was a problem hiding this comment.
This looks good to me! Thanks again @PieterPenninckx
|
@homu r+ rollup |
|
@bors r+ rollup r=KodrAus |
|
📌 Commit ea814b8 has been approved by |
|
📌 Commit ea814b8 has been approved by |
Small improvements to the documentation of VecDeque. Some small improvements to the documentation of `VecDeque`.
|
Whoops... Wrong buildbot :) |
Some small improvements to the documentation of
VecDeque.