[Bf-blender-cvs] [59054d5eba4] blender2.8: Python API: fix docstrings

Jacques Lucke noreply at git.blender.org
Mon Oct 22 15:02:09 CEST 2018


Commit: 59054d5eba487a0c79661e7b8f774edc75e582e0
Author: Jacques Lucke
Date:   Mon Oct 22 15:01:25 2018 +0200
Branches: blender2.8
https://developer.blender.org/rB59054d5eba487a0c79661e7b8f774edc75e582e0

Python API: fix docstrings

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

M	source/blender/python/gpu/gpu_py_shader.c

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

diff --git a/source/blender/python/gpu/gpu_py_shader.c b/source/blender/python/gpu/gpu_py_shader.c
index de19e8ab0cf..07a139de418 100644
--- a/source/blender/python/gpu/gpu_py_shader.c
+++ b/source/blender/python/gpu/gpu_py_shader.c
@@ -729,7 +729,7 @@ static PyObject *bpygpu_shader_unbind(BPyGPUShader *UNUSED(self))
 }
 
 PyDoc_STRVAR(bpygpu_shader_from_builtin_doc,
-".. function:: shader_from_builtin(shader_name)\n"
+".. function:: from_builtin(shader_name)\n"
 "\n"
 "   :param shader_name: One of these builtin shader names: {\n"
 "       '2D_UNIFORM_COLOR',\n"
@@ -740,6 +740,8 @@ PyDoc_STRVAR(bpygpu_shader_from_builtin_doc,
 "       '3D_FLAT_COLOR',\n"
 "       '3D_SMOOTH_COLOR'}\n"
 "   :type shader_name: str\n"
+"   :return: the shader object\n"
+"   :rtype: bpy.types.GPUShader\n"
 );
 static PyObject *bpygpu_shader_from_builtin(PyObject *UNUSED(self), PyObject *arg)
 {
@@ -755,7 +757,7 @@ static PyObject *bpygpu_shader_from_builtin(PyObject *UNUSED(self), PyObject *ar
 }
 
 PyDoc_STRVAR(bpygpu_shader_code_from_builtin_doc,
-".. function:: shader_code_from_builtin(shader_name)\n"
+".. function:: code_from_builtin(shader_name)\n"
 "\n"
 "   :param shader_name: One of these builtin shader names: {\n"
 "       '2D_UNIFORM_COLOR',\n"



More information about the Bf-blender-cvs mailing list