diff options
author | Campbell Barton <campbell@blender.org> | 2022-09-19 07:22:31 +0300 |
---|---|---|
committer | Campbell Barton <campbell@blender.org> | 2022-09-19 07:24:31 +0300 |
commit | 4baa6e57bd4240e0dab1e2a1b426698ca4d593bc (patch) | |
tree | 8c9af26e0dbda778263f677c99ece9de0af7c61a /source/blender/python/intern | |
parent | 8a9f6a2e0a15ed6d5fcab7030249f0211b667d60 (diff) |
Cleanup: prefer 'arg' over 'params' for sphinx documentation
While both are supported, 'arg' is in more common use so prefer it.
Diffstat (limited to 'source/blender/python/intern')
-rw-r--r-- | source/blender/python/intern/bpy_rna_operator.c | 2 | ||||
-rw-r--r-- | source/blender/python/intern/bpy_rna_types_capi.c | 12 |
2 files changed, 7 insertions, 7 deletions
diff --git a/source/blender/python/intern/bpy_rna_operator.c b/source/blender/python/intern/bpy_rna_operator.c index fd6cc93ed32..e0a4356dc18 100644 --- a/source/blender/python/intern/bpy_rna_operator.c +++ b/source/blender/python/intern/bpy_rna_operator.c @@ -84,7 +84,7 @@ PyDoc_STRVAR(BPY_rna_operator_poll_message_set_doc, " When message is callable, " "additional user defined positional arguments are passed to the message function.\n" "\n" - " :param message: The message or a function that returns the message.\n" + " :arg message: The message or a function that returns the message.\n" " :type message: string or a callable that returns a string or None.\n"); static PyObject *BPY_rna_operator_poll_message_set(PyObject *UNUSED(self), PyObject *args) diff --git a/source/blender/python/intern/bpy_rna_types_capi.c b/source/blender/python/intern/bpy_rna_types_capi.c index c3a07847aff..2b830eb9ffe 100644 --- a/source/blender/python/intern/bpy_rna_types_capi.c +++ b/source/blender/python/intern/bpy_rna_types_capi.c @@ -185,16 +185,16 @@ PyDoc_STRVAR( " It will be called every time the specified region in the space 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 region is drawn.\n" " It gets the specified arguments as input.\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 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" - " :param draw_type: Usually ``POST_PIXEL`` for 2D drawing and ``POST_VIEW`` for 3D drawing. " + " :arg draw_type: Usually ``POST_PIXEL`` for 2D drawing and ``POST_VIEW`` for 3D drawing. " "In some cases ``PRE_VIEW`` can be used. ``BACKDROP`` can be used for backdrops in the node " "editor.\n" " :type draw_type: str\n" @@ -206,9 +206,9 @@ PyDoc_STRVAR(pyrna_draw_handler_remove_doc, "\n" " Remove a draw handler that was added previously.\n" "\n" - " :param handler: The draw handler that should be removed.\n" + " :arg handler: The draw handler that should be removed.\n" " :type handler: object\n" - " :param region_type: Region type the callback was added to.\n" + " :arg region_type: Region type the callback was added to.\n" " :type region_type: str\n"); static struct PyMethodDef pyrna_space_methods[] = { |