Add docs to helper

oxideai · Apr 16, 2024 · 9f4a216 · 9f4a216
1 parent 75dd7af
commit 9f4a216
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/src/utils.rs b/src/utils.rs
@@ -1,3 +1,4 @@
+/// Helper method to get a string representation of an mlx object.
 pub(crate) fn mlx_describe(ptr: *mut ::std::os::raw::c_void) -> Option<String> {
     let mlx_description = unsafe { mlx_sys::mlx_tostring(ptr) };
     let c_str = unsafe { mlx_sys::mlx_string_data(mlx_description) };