From 4e188dd66c289a5a6f1e0438360111d5c20a761e Mon Sep 17 00:00:00 2001 From: Alexander Heinrich Date: Wed, 11 Oct 2023 22:20:16 +0200 Subject: [PATCH] Update docs of PriorityQueue.iterator() and PriorityDeque.iterator() --- lib/std/priority_dequeue.zig | 3 ++- lib/std/priority_queue.zig | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/lib/std/priority_dequeue.zig b/lib/std/priority_dequeue.zig index 04f0451561..31ae965286 100644 --- a/lib/std/priority_dequeue.zig +++ b/lib/std/priority_dequeue.zig @@ -416,7 +416,8 @@ pub fn PriorityDequeue(comptime T: type, comptime Context: type, comptime compar }; /// Return an iterator that walks the queue without consuming - /// it. Invalidated if the queue is modified. + /// it. The iteration order may differ from the priority order. + /// Invalidated if the queue is modified. pub fn iterator(self: *Self) Iterator { return Iterator{ .queue = self, diff --git a/lib/std/priority_queue.zig b/lib/std/priority_queue.zig index 5d8912ec13..a568eeadcf 100644 --- a/lib/std/priority_queue.zig +++ b/lib/std/priority_queue.zig @@ -231,7 +231,8 @@ pub fn PriorityQueue(comptime T: type, comptime Context: type, comptime compareF }; /// Return an iterator that walks the queue without consuming - /// it. Invalidated if the heap is modified. + /// it. The iteration order may differ from the priority order. + /// Invalidated if the heap is modified. pub fn iterator(self: *Self) Iterator { return Iterator{ .queue = self,