blender
/
blender
137
404
Fork 586
Code Issues 6.2k Pull Requests 761 Projects 19 Wiki Activity

Cleanup: use arg instead of param for generated sphinx docs

This commit is contained in:
Campbell Barton 2023-02-07 15:14:22 +11:00
parent db8b5a2316
commit 44daeaae7d
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
source/blender/python/intern/bpy_rna_types_capi.c
View File

@ -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[] = {