From f88f0517f7ecb75c481ffe8b551e3cf66497407b Mon Sep 17 00:00:00 2001 From: Jackson Novak <80219532+Oglo12@users.noreply.github.com> Date: Wed, 16 Apr 2025 03:07:16 -0500 Subject: [PATCH] [Documentation] Fix Clay_String definition in README.md file. (#374) --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 352069d..a7c8467 100644 --- a/README.md +++ b/README.md @@ -1787,7 +1787,8 @@ Note: when using the debug tools, their internal colors are represented as 0-255 ```C typedef struct { - int length; + bool isStaticallyAllocated; + int32_t length; const char *chars; } Clay_String; ``` @@ -1796,7 +1797,14 @@ typedef struct { **Fields** -**`.length`** - `int` +**`.isStaticallyAllocated`** - `bool` + +Whether or not the string is statically allocated, or in other words, whether +or not it lives for the entire lifetime of the program. + +--- + +**`.length`** - `int32_t` The number of characters in the string, _not including an optional null terminator._