Welcome to mirror list, hosted at ThFree Co, Russian Federation.

git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAaron Carlisle <carlisle.b3d@gmail.com>2020-09-29 23:45:29 +0300
committerAaron Carlisle <carlisle.b3d@gmail.com>2020-09-29 23:45:29 +0300
commitf855dc8ce9dc8a9465ad72b4f3ba290eacde8fb0 (patch)
treeefd4f246b4f292cf8e99128ae8375a88b3fd3ef3 /source/blender/python/intern/bpy_rna.c
parentdb346ac2cd24ce31a2f5c2328603000ec58e9366 (diff)
API Docs: Correct syntax for bpy.utils.register_class
Diffstat (limited to 'source/blender/python/intern/bpy_rna.c')
-rw-r--r--source/blender/python/intern/bpy_rna.c21
1 files changed, 13 insertions, 8 deletions
diff --git a/source/blender/python/intern/bpy_rna.c b/source/blender/python/intern/bpy_rna.c
index e71adbfdf62..30174e9c605 100644
--- a/source/blender/python/intern/bpy_rna.c
+++ b/source/blender/python/intern/bpy_rna.c
@@ -8700,16 +8700,21 @@ void pyrna_free_types(void)
PyDoc_STRVAR(pyrna_register_class_doc,
".. method:: register_class(cls)\n"
"\n"
- " Register a subclass of a blender type in (:class:`bpy.types.Panel`,\n"
- " :class:`bpy.types.UIList`, :class:`bpy.types.Menu`, :class:`bpy.types.Header`,\n"
- " :class:`bpy.types.Operator`, :class:`bpy.types.KeyingSetInfo`,\n"
- " :class:`bpy.types.RenderEngine`).\n"
- "\n"
- " If the class has a *register* class method it will be called\n"
- " before registration.\n"
+ " Register a subclass of a Blender type class.\n"
"\n"
+ " :arg cls: Blender type class in:\n"
+ " :class:`bpy.types.Panel`, :class:`bpy.types.UIList`,\n"
+ " :class:`bpy.types.Menu`, :class:`bpy.types.Header`,\n"
+ " :class:`bpy.types.Operator`, :class:`bpy.types.KeyingSetInfo`,\n"
+ " :class:`bpy.types.RenderEngine`\n"
+ " :type cls: class\n"
" :raises ValueError:\n"
- " if the class is not a subclass of a registerable blender class.\n");
+ " if the class is not a subclass of a registerable blender class.\n"
+ "\n"
+ " .. note::\n"
+ "\n"
+ " If the class has a *register* class method it will be called\n"
+ " before registration.\n");
PyMethodDef meth_bpy_register_class = {
"register_class", pyrna_register_class, METH_O, pyrna_register_class_doc};
static PyObject *pyrna_register_class(PyObject *UNUSED(self), PyObject *py_class)