aboutsummaryrefslogtreecommitdiff
path: root/core/container/small_array
diff options
context:
space:
mode:
Diffstat (limited to 'core/container/small_array')
-rw-r--r--core/container/small_array/doc.odin9
1 files changed, 4 insertions, 5 deletions
diff --git a/core/container/small_array/doc.odin b/core/container/small_array/doc.odin
index f3e9acd57..21d000a10 100644
--- a/core/container/small_array/doc.odin
+++ b/core/container/small_array/doc.odin
@@ -1,8 +1,7 @@
/*
-Package small_array implements a dynamic array like
-interface on a stack-allocated, fixed-size array.
+A dynamic array-like interface on a stack-allocated, fixed-size array.
-The Small_Array type is optimal for scenarios where you need
+The `Small_Array` type is optimal for scenarios where you need
a container for a fixed number of elements of a specific type,
with the total number known at compile time but the exact
number to be used determined at runtime.
@@ -33,7 +32,7 @@ Example:
return
}
- // the Small_Array can be an ordinary parameter 'generic' over
+ // the `Small_Array` can be an ordinary parameter 'generic' over
// the actual length to be usable with different sizes
print_elements :: proc(arr: ^small_array.Small_Array($N, rune)) {
for r in small_array.slice(arr) {
@@ -52,4 +51,4 @@ Output:
Hellope
*/
-package container_small_array
+package container_small_array \ No newline at end of file