Update foreach_get/_set doc.

1 files changed, 7 insertions, 1 deletions

diff --git a/source/blender/python/intern/bpy_rna.c b/source/blender/python/intern/bpy_rna.c
index 808c07a35a8..754fd25d32b 100644
--- a/source/blender/python/intern/bpy_rna.c
+++ b/source/blender/python/intern/bpy_rna.c
@@ -4601,12 +4601,15 @@ PyDoc_STRVAR(pyrna_prop_collection_foreach_get_doc,
 "\n"
 "   This is a function to give fast access to attributes within a collection.\n"
 "\n"
+"   Only works for 'basic type' properties (bool, int and float)!\n"
+"   Multi-dimensional arrays (like array of vectors) will be flattened into seq.\n"
+"\n"
 "   .. code-block:: python\n"
 "\n"
 "      collection.foreach_get(attr, someseq)\n"
 "\n"
 "      # Python equivalent\n"
-"      for i in range(len(seq)): someseq[i] = getattr(collection, attr)\n"
+"      for i in range(len(seq)): someseq[i] = getattr(collection[i], attr)\n"
 "\n"
 );
 static PyObject *pyrna_prop_collection_foreach_get(BPy_PropertyRNA *self, PyObject *args)
@@ -4621,6 +4624,9 @@ PyDoc_STRVAR(pyrna_prop_collection_foreach_set_doc,
 "\n"
 "   This is a function to give fast access to attributes within a collection.\n"
 "\n"
+"   Only works for 'basic type' properties (bool, int and float)!\n"
+"   seq must be uni-dimensional, multi-dimensional arrays (like array of vectors) will be re-created from it.\n"
+"\n"
 "   .. code-block:: python\n"
 "\n"
 "      collection.foreach_set(attr, seq)\n"