[Bf-blender-cvs] [809b33b69a0] master: Docs: improve the error when undo poll fails

[Campbell Barton]

Commit: 809b33b69a04fc37e1535697b667158ca80f6d60
Author: Campbell Barton
Date:   Thu Sep 2 15:29:33 2021 +1000
Branches: master
https://developer.blender.org/rB809b33b69a04fc37e1535697b667158ca80f6d60

Docs: improve the error when undo poll fails

Calling undo in from Python background-mode would raise an exception
without any information about how to initialize undo.

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

M	source/blender/editors/undo/ed_undo.c

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

diff --git a/source/blender/editors/undo/ed_undo.c b/source/blender/editors/undo/ed_undo.c
index 3e0029156c1..84d5d3b9aae 100644
--- a/source/blender/editors/undo/ed_undo.c
+++ b/source/blender/editors/undo/ed_undo.c
@@ -574,7 +574,12 @@ static bool ed_undo_is_init_poll(bContext *C)
 {
   wmWindowManager *wm = CTX_wm_manager(C);
   if (wm->undo_stack == NULL) {
-    CTX_wm_operator_poll_msg_set(C, "Undo disabled at startup");
+    /* This message is intended for Python developers,
+     * it will be part of the exception when attempting to call undo in background mode. */
+    CTX_wm_operator_poll_msg_set(
+        C,
+        "Undo disabled at startup in background-mode. "
+        "Call `ed.undo_push()` to explicitly initialize the undo-system.");
     return false;
   }
   return true;