Fix docu-comment for Deviceptr.mem_free

lukstafi · Dec 11, 2024 · f9d02b3 · f9d02b3
1 parent 56d7b06
commit f9d02b3
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/CHANGES.md b/CHANGES.md
@@ -1,3 +1,9 @@
+## [0.6.2] current
+
+### Fixed
+
+- Documentation for `Deviceptr.mem_free`: mention it's safe to call multiple times on the same pointer.
+
 ## [0.6.1] 2024-12-02
 
 ### Added

diff --git a/cudajit.mli b/cudajit.mli
@@ -428,7 +428,7 @@ module Deviceptr : sig
        without needing to set the proper context}. *)
 
   val mem_free : t -> unit
-  (** See
+  (** Double-freeing is prevented by a flag: multiple calls on the same [Deviceptr.t] are safe. See
       {{:https://docs.nvidia.com/cuda/cuda-driver-api/group__CUDA__MEM.html#group__CUDA__MEM_1g89b3f154e17cc89b6eea277dbdf5c93a}
        cuMemFree}. *)