about summary refs log tree commit diff
path: root/src/librustc_data_structures
diff options
context:
space:
mode:
authorkennytm <kennytm@gmail.com>2018-10-01 16:13:02 +0800
committerGitHub <noreply@github.com>2018-10-01 16:13:02 +0800
commit9ad783e09e0ce3016cf8768d874f04bd102c9acd (patch)
tree7404169826fb881f084e010f9faf52be80a67bda /src/librustc_data_structures
parent41706ff12b39e5efaf97f6a0b6163bc521815cb7 (diff)
parentaf9eb4fc21bfeb7317446581194b659df2e73fa5 (diff)
downloadrust-9ad783e09e0ce3016cf8768d874f04bd102c9acd.tar.gz
rust-9ad783e09e0ce3016cf8768d874f04bd102c9acd.zip
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.
Diffstat (limited to 'src/librustc_data_structures')
-rw-r--r--src/librustc_data_structures/work_queue.rs2
1 files changed, 1 insertions, 1 deletions
diff --git a/src/librustc_data_structures/work_queue.rs b/src/librustc_data_structures/work_queue.rs
index af9ed9306eb..eff80a98c9d 100644
--- a/src/librustc_data_structures/work_queue.rs
+++ b/src/librustc_data_structures/work_queue.rs
@@ -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() {