From e2eeba7dae5d31fc92a36035345ada42f78fc752 Mon Sep 17 00:00:00 2001
From: teoxoy <28601907+teoxoy@users.noreply.github.com>
Date: Tue, 26 Nov 2024 12:50:46 +0100
Subject: [PATCH] [wgpu-core] document which closures are guaranteed to be
 called

---
 wgpu-core/src/device/global.rs | 3 ++-
 wgpu-core/src/device/queue.rs  | 1 +
 2 files changed, 3 insertions(+), 1 deletion(-)

diff --git a/wgpu-core/src/device/global.rs b/wgpu-core/src/device/global.rs
index d86b66b98f..b2bdba04b0 100644
--- a/wgpu-core/src/device/global.rs
+++ b/wgpu-core/src/device/global.rs
@@ -2083,7 +2083,7 @@ impl Global {
         self.hub.devices.remove(device_id);
     }
 
-    /// This closure will be called exactly once during "lose the device".
+    /// `device_lost_closure` might never be called.
     pub fn device_set_device_lost_closure(
         &self,
         device_id: DeviceId,
@@ -2144,6 +2144,7 @@ impl Global {
         self.hub.queues.remove(queue_id);
     }
 
+    /// `op.callback` is guaranteed to be called.
     pub fn buffer_map_async(
         &self,
         buffer_id: id::BufferId,
diff --git a/wgpu-core/src/device/queue.rs b/wgpu-core/src/device/queue.rs
index 1bb0d892c4..ce59294e7d 100644
--- a/wgpu-core/src/device/queue.rs
+++ b/wgpu-core/src/device/queue.rs
@@ -1396,6 +1396,7 @@ impl Queue {
         unsafe { self.raw().get_timestamp_period() }
     }
 
+    /// `closure` is guaranteed to be called.
     pub fn on_submitted_work_done(
         &self,
         closure: SubmittedWorkDoneClosure,