Docs: BMesh.from_mesh behavior w/ multiple calls
authorCampbell Barton <ideasman42@gmail.com>
Mon, 28 Aug 2017 02:40:36 +0000 (12:40 +1000)
committerCampbell Barton <ideasman42@gmail.com>
Mon, 28 Aug 2017 04:25:00 +0000 (14:25 +1000)
source/blender/python/bmesh/bmesh_py_types.c

index 9b1cd93093b877fa994a0ebb71f7c3fa31311bff..caf836fa5b82956948a33eab8ab4fe98b7ab6108 100644 (file)
@@ -1041,6 +1041,13 @@ PyDoc_STRVAR(bpy_bmesh_from_mesh_doc,
 "   :type use_shape_key: boolean\n"
 "   :arg shape_key_index: The shape key index to use.\n"
 "   :type shape_key_index: int\n"
+"\n"
+"   .. note::\n"
+"\n"
+"      Multiple calls can be used to join multiple meshes.\n"
+"\n"
+"      Custom-data layers are only copied from ``mesh`` on initialization.\n"
+"      Further calls will copy custom-data to matching layers, layers missing on the target mesh wont be added.\n"
 );
 static PyObject *bpy_bmesh_from_mesh(BPy_BMesh *self, PyObject *args, PyObject *kw)
 {