From: Kevin Day <Kevin@kevux.org>
Date: Mon, 19 Aug 2024 02:38:26 +0000 (-0500)
Subject: Update: Function documentation for f_memory_array_increase().
X-Git-Tag: 0.7.0~100
X-Git-Url: https://git.kevux.org/?a=commitdiff_plain;h=7c61bc182f4a412d07462943e0e59162775cddd0;p=fll

Update: Function documentation for f_memory_array_increase().

The documentation comment needs to communicate the current behavior of (used + amount <= size).

I may end up reviewing this behavior in the future.
---

diff --git a/level_0/f_memory/c/memory/array.h b/level_0/f_memory/c/memory/array.h
index d8037be..876b92e 100644
--- a/level_0/f_memory/c/memory/array.h
+++ b/level_0/f_memory/c/memory/array.h
@@ -294,7 +294,7 @@ extern "C" {
 #endif // _di_f_memory_array_increase_
 
 /**
- * Increase the size of the memory array by the given amount.
+ * Increase the size of the memory array by the given amount if and only if (used + amount > size).
  *
  * This will resize making the array larger based on the given length.
  *