diff options
Diffstat (limited to 'source/blender/python/intern/bpy_msgbus.c')
| -rw-r--r-- | source/blender/python/intern/bpy_msgbus.c | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/source/blender/python/intern/bpy_msgbus.c b/source/blender/python/intern/bpy_msgbus.c index 75a5f6f72ae..9e165bbf1c0 100644 --- a/source/blender/python/intern/bpy_msgbus.c +++ b/source/blender/python/intern/bpy_msgbus.c @@ -208,6 +208,9 @@ static void bpy_msgbus_subscribe_value_free_data(struct wmMsgSubscribeKey *UNUSE PyDoc_STRVAR( bpy_msgbus_subscribe_rna_doc, ".. function:: subscribe_rna(key, owner, args, notify, options=set())\n" + "\n" + " Register a message bus subscription. It will be cleared when another blend file is\n" + " loaded, or can be cleared explicitly via :func:`bpy.msgbus.clear_by_owner`.\n" "\n" BPY_MSGBUS_RNA_MSGKEY_DOC " :arg owner: Handle for this subscription (compared by identity).\n" " :type owner: Any type.\n" @@ -215,7 +218,12 @@ PyDoc_STRVAR( "\n" " - ``PERSISTENT`` when set, the subscriber will be kept when remapping ID data.\n" "\n" - " :type options: set of str.\n"); + " :type options: set of str.\n" + "\n" + ".. note::\n" + "\n" + " All subscribers will be cleared on file-load. Subscribers can be re-registered on load,\n" + " see :mod:`bpy.app.handlers.load_post`.\n"); static PyObject *bpy_msgbus_subscribe_rna(PyObject *UNUSED(self), PyObject *args, PyObject *kw) { const char *error_prefix = "subscribe_rna"; |