authorgravatar for alxhnr@users.noreply.github.comAlexander Heinrich <alxhnr@users.noreply.github.com> 2023-10-11 22:20:16+02:00
committergravatar for git@vexu.euVeikka Tuominen <git@vexu.eu> 2023-10-12 04:48:22+03:00
log4e188dd66c289a5a6f1e0438360111d5c20a761e
tree97647bf4662b6571a6681ba17c94ee4c47c966d8
parent13022749105be7167d2c97222215ae5f30c24527

Update docs of PriorityQueue.iterator() and PriorityDeque.iterator()

2 files changed, 4 insertions(+), 2 deletions(-)

lib/std/priority_dequeue.zig+2-1
...@@ -416,7 +416,8 @@ pub fn PriorityDequeue(comptime T: type, comptime Context: type, comptime compar...@@ -416,7 +416,8 @@ pub fn PriorityDequeue(comptime T: type, comptime Context: type, comptime compar
416 };416 };
417417
418 /// Return an iterator that walks the queue without consuming418 /// Return an iterator that walks the queue without consuming
419 /// it. Invalidated if the queue is modified.419 /// it. The iteration order may differ from the priority order.
420 /// Invalidated if the queue is modified.
420 pub fn iterator(self: *Self) Iterator {421 pub fn iterator(self: *Self) Iterator {
421 return Iterator{422 return Iterator{
422 .queue = self,423 .queue = self,
lib/std/priority_queue.zig+2-1
...@@ -231,7 +231,8 @@ pub fn PriorityQueue(comptime T: type, comptime Context: type, comptime compareF...@@ -231,7 +231,8 @@ pub fn PriorityQueue(comptime T: type, comptime Context: type, comptime compareF
231 };231 };
232232
233 /// Return an iterator that walks the queue without consuming233 /// Return an iterator that walks the queue without consuming
234 /// it. Invalidated if the heap is modified.234 /// it. The iteration order may differ from the priority order.
235 /// Invalidated if the heap is modified.
235 pub fn iterator(self: *Self) Iterator {236 pub fn iterator(self: *Self) Iterator {
236 return Iterator{237 return Iterator{
237 .queue = self,238 .queue = self,