From b5e90b2495c0c66670c94f9ae6a50434490fa9af Mon Sep 17 00:00:00 2001
From: Johannes Stoelp <johannes.stoelp@gmail.com>
Date: Tue, 14 Sep 2021 22:47:33 +0200
Subject: lib: updated comment on SmallCStr

---
 src/lib.rs | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'src/lib.rs')

diff --git a/src/lib.rs b/src/lib.rs
index 64721a7..1e1112e 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -9,6 +9,8 @@ pub mod parser;
 pub const SMALL_STR_SIZE: usize = 16;
 
 /// Small C string on the stack with fixed size [`SMALL_STR_SIZE`].
+///
+/// This is specially crafted to interact with the LLVM C API and get rid of some heap allocations.
 #[derive(Debug, PartialEq)]
 pub struct SmallCStr([u8; SMALL_STR_SIZE]);
 
-- 
cgit v1.2.3