[Bf-blender-cvs] [7ccd19fc128] master: PyAPI: update docs to include poll_message_set reference

Campbell Barton noreply at git.blender.org
Tue Apr 20 04:29:30 CEST 2021


Commit: 7ccd19fc1288f64393f64b3249497c919f5f0a04
Author: Campbell Barton
Date:   Tue Apr 20 12:28:36 2021 +1000
Branches: master
https://developer.blender.org/rB7ccd19fc1288f64393f64b3249497c919f5f0a04

PyAPI: update docs to include poll_message_set reference

Part of D9738

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

M	doc/python_api/rst/info_gotcha.rst

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

diff --git a/doc/python_api/rst/info_gotcha.rst b/doc/python_api/rst/info_gotcha.rst
index e5ff56063b5..df6e7297e26 100644
--- a/doc/python_api/rst/info_gotcha.rst
+++ b/doc/python_api/rst/info_gotcha.rst
@@ -50,7 +50,8 @@ you should be able to find the poll function with no knowledge of C.
 
    Blender does have the functionality for poll functions to describe why they fail,
    but its currently not used much, if you're interested to help improve the API
-   feel free to add calls to ``CTX_wm_operator_poll_msg_set`` where its not obvious why poll fails, e.g:
+   feel free to add calls to :class:`bpy.types.Operator.poll_message_set` (``CTX_wm_operator_poll_msg_set`` in C)
+   where its not obvious why poll fails, e.g:
 
       >>> bpy.ops.gpencil.draw()
       RuntimeError: Operator bpy.ops.gpencil.draw.poll() Failed to find Grease Pencil data to draw into



More information about the Bf-blender-cvs mailing list