From a43ffcacc236d4b571dd28a6a861b73f4c2304d6 Mon Sep 17 00:00:00 2001
From: Emi Gutekanst <emi@hexops.com>
Date: Wed, 27 Nov 2024 18:30:21 -0700
Subject: [PATCH] object: clarify comment

---
 src/module.zig | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/src/module.zig b/src/module.zig
index e08c94bc..e81ce413 100644
--- a/src/module.zig
+++ b/src/module.zig
@@ -316,8 +316,9 @@ pub fn Objects(options: ObjectsOptions, comptime T: type) type {
             return unpacked;
         }
 
-        /// Returns true if the field has an `updated` bit set in internal, after setting the bit
-        /// back to false.
+        /// If options have tracking enabled, this returns true when the given field has been set using the set()
+        /// or setAll() methods. A subsequent call to .updated() will return false until another set() or setAll()
+        /// call is made.
         pub fn updated(objs: *@This(), id: ObjectID, field_name: anytype) bool {
             if (options.track_fields) {
                 const unpacked = objs.validateAndUnpack(id, "updated");