perlapi: Note that StructCopy is a shallow copy;

This is essential information that should be revealed up front.
Perl · Nov 22, 2023 · 846cc44 · 846cc44
1 parent f276fe5
commit 846cc44
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/handy.h b/handy.h
@@ -2688,7 +2688,8 @@ optimise.
 
 =for apidoc_section $utility
 =for apidoc Amu|void|StructCopy|type *src|type *dest|type
-This is an architecture-independent macro to copy one structure to another.
+This is an architecture-independent macro that does a shallow copy of one
+structure to another.
 
 =for apidoc Am|void|PoisonWith|void* dest|int nitems|type|U8 byte