Merge pull request argotorg#15533 from haoyang9804/calldata_doc

matheusaaguiar · web-flow · commit b0d991bd4b3b · 2024-11-11T00:08:14.000-03:00
Add note about calldata arrays and structs initialization in docs
diff --git a/docs/types/reference-types.rst b/docs/types/reference-types.rst
@@ -37,6 +37,14 @@ non-persistent area where function arguments are stored, and behaves mostly like
     data location can also be returned from functions, but it is not possible to
     allocate such types.
 
+.. note::
+    Arrays and structs with ``calldata`` location declared in a function body
+    or as its return parameters must be assigned before being used or returned.
+    There are certain cases in which non-trivial control flow is used and the compiler
+    can't properly detect the initialization.
+    A common workaround in such cases is to assign the affected variable to itself before
+    the correct initialization takes place.
+
 .. note::
     Prior to version 0.6.9 data location for reference-type arguments was limited to
     ``calldata`` in external functions, ``memory`` in public functions and either
