docs(xml-element): add explanation documentation to MemoryWriter.TryR…

…elease()
y-crdt · Aug 17, 2023 · e5d8ce3 · e5d8ce3
1 parent c9e84b1
commit e5d8ce3
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/YDotNet/Infrastructure/MemoryWriter.cs b/YDotNet/Infrastructure/MemoryWriter.cs
@@ -93,6 +93,11 @@ internal static bool TryRelease(nint pointer)
             return false;
         }
 
+        // This method doesn't throw if called with `nint.Zero` but having a `Try*` version
+        // makes the API more future-friendly and easier to understand for C# developers.
+        //
+        // If they called a `TryWrite*` method, they should call a `TryRelease` method too.
+        // Otherwise, they should call `Release`.
         Release(pointer);
 
         return true;