[Bf-blender-cvs] [44daeaae7de] master: Cleanup: use arg instead of param for generated sphinx docs
Campbell Barton
noreply at git.blender.org
Tue Feb 7 05:15:38 CET 2023
Commit: 44daeaae7de7e80c7826a3853284a94de2583fda
Author: Campbell Barton
Date: Tue Feb 7 15:14:22 2023 +1100
Branches: master
https://developer.blender.org/rB44daeaae7de7e80c7826a3853284a94de2583fda
Cleanup: use arg instead of param for generated sphinx docs
===================================================================
M source/blender/python/intern/bpy_rna_types_capi.c
===================================================================
diff --git a/source/blender/python/intern/bpy_rna_types_capi.c b/source/blender/python/intern/bpy_rna_types_capi.c
index 99bcc17654a..45642cb1f1c 100644
--- a/source/blender/python/intern/bpy_rna_types_capi.c
+++ b/source/blender/python/intern/bpy_rna_types_capi.c
@@ -148,17 +148,17 @@ PyDoc_STRVAR(
"type will be drawn.\n"
" Note: All arguments are positional only for now.\n"
"\n"
- " :param callback:\n"
+ " :arg callback:\n"
" A function that will be called when the cursor is drawn.\n"
" It gets the specified arguments as input with the mouse position (tuple) as last "
"argument.\n"
" :type callback: function\n"
- " :param args: Arguments that will be passed to the callback.\n"
+ " :arg args: Arguments that will be passed to the callback.\n"
" :type args: tuple\n"
- " :param space_type: The space type the callback draws in; for example ``VIEW_3D``. "
+ " :arg space_type: The space type the callback draws in; for example ``VIEW_3D``. "
"(:class:`bpy.types.Space.type`)\n"
" :type space_type: str\n"
- " :param region_type: The region type the callback draws in; usually ``WINDOW``. "
+ " :arg region_type: The region type the callback draws in; usually ``WINDOW``. "
"(:class:`bpy.types.Region.type`)\n"
" :type region_type: str\n"
" :return: Handler that can be removed later on.\n"
@@ -169,7 +169,7 @@ PyDoc_STRVAR(pyrna_draw_cursor_remove_doc,
"\n"
" Remove a draw cursor handler that was added previously.\n"
"\n"
- " :param handler: The draw cursor handler that should be removed.\n"
+ " :arg handler: The draw cursor handler that should be removed.\n"
" :type handler: object\n");
static struct PyMethodDef pyrna_windowmanager_methods[] = {
More information about the Bf-blender-cvs
mailing list