Rollup merge of #54656 - nieksand:workqueue_doc, r=varkor

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.
This commit is contained in:
kennytm 2018-10-01 16:13:02 +08:00 committed by GitHub
commit 9ad783e09e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -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 an element from the work queue.
#[inline]
pub fn pop(&mut self) -> Option<T> {
if let Some(element) = self.deque.pop_front() {