Correct doc for WorkQueue<T>::pop(). #54656
Conversation
|
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @varkor (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
added
the
S-waiting-on-review
| @@ -53,7 +53,7 @@ impl<T: Idx> WorkQueue<T> { | |||
| } | |||
| } | |||
|
|
|||
| /// Attempt to enqueue `element` in the work queue. Returns false if it was already present. | |||
| /// Attempt to pop element from the work queue. | |||
There was a problem hiding this comment.
Repushed with change.
Change is in separate commit. Let me know if I should squash it with rebase instead.
There was a problem hiding this comment.
Thanks — if you could squash instead, that would be great!
|
blergh. Just screwed that up. Will untangle the git mess in a bit. |
nieksand
force-pushed
the
workqueue_doc
branch
from
9bb642c to
af9eb4f
Compare
|
Cleaned up the git mess. Single commit with change. |
|
📌 Commit af9eb4f has been approved by |
bors
added
S-waiting-on-bors
|
Thanks for reviewing |
Correct doc for WorkQueue<T>::pop(). The old function doc looks like copy-pasta from WorkQueue::insert(). WorkQueue::pop() does not enqueue nor does it return a boolean false. Doc corrected accordingly.
Rollup of 13 pull requests Successful merges: - #53784 (Document that slices cannot be larger than `isize::MAX` bytes) - #54308 (Better user experience when attempting to call associated functions with dot notation) - #54488 (in which we include attributes in unused `extern crate` suggestion spans) - #54544 (Indicate how to move value out of Box in docs.) - #54623 (Added help message for `impl_trait_in_bindings` feature gate) - #54641 (A few cleanups and minor improvements to rustc/infer) - #54656 (Correct doc for WorkQueue<T>::pop().) - #54674 (update miri) - #54676 (Remove `-Z disable_ast_check_for_mutation_in_guard`) - #54679 (Improve bug! message for impossible case in Relate) - #54681 (Rename sanitizer runtime libraries on OSX) - #54708 (Make ./x.py help <cmd> invoke ./x.py <cmd> -h on its own) - #54713 (Add nightly check for tool_lints warning)
The old function doc looks like copy-pasta from WorkQueue::insert().
WorkQueue::pop() does not enqueue nor does it return a boolean false. Doc corrected accordingly.