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 d8037bedb29e0441e198617a0e304448a92ed51d..876b92e0c0f6cff98e25e9992157e5d8653d4357 100644 (file)
--- 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.
  *