[Bf-blender-cvs] [4d71138738c] master: Docs: note that message-bus subscribers are reset on file load

[Campbell Barton]

Commit: 4d71138738ca8ba7e4908328d81d1f6c95fc84cd
Author: Campbell Barton
Date:   Fri Oct 8 23:43:01 2021 +1100
Branches: master
https://developer.blender.org/rB4d71138738ca8ba7e4908328d81d1f6c95fc84cd

Docs: note that message-bus subscribers are reset on file load

===================================================================

M	source/blender/python/intern/bpy_msgbus.c

===================================================================

diff --git a/source/blender/python/intern/bpy_msgbus.c b/source/blender/python/intern/bpy_msgbus.c
index bf70f8158d2..9e165bbf1c0 100644
--- a/source/blender/python/intern/bpy_msgbus.c
+++ b/source/blender/python/intern/bpy_msgbus.c
@@ -218,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";