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/mathutils | |
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/mathutils')
5 files changed, 7 insertions, 8 deletions
diff --git a/source/blender/python/mathutils/mathutils_Color.c b/source/blender/python/mathutils/mathutils_Color.c index 88e8d880360..955fa4b6f92 100644 --- a/source/blender/python/mathutils/mathutils_Color.c +++ b/source/blender/python/mathutils/mathutils_Color.c @@ -1102,7 +1102,7 @@ PyDoc_STRVAR( " the OpenColorIO configuration. The notable exception is user interface theming colors, " " which are in sRGB color space.\n" "\n" - " :param rgb: (r, g, b) color values\n" + " :arg rgb: (r, g, b) color values\n" " :type rgb: 3d vector\n"); PyTypeObject color_Type = { PyVarObject_HEAD_INIT(NULL, 0) "Color", /* tp_name */ diff --git a/source/blender/python/mathutils/mathutils_Euler.c b/source/blender/python/mathutils/mathutils_Euler.c index f49868dfba7..8f950bce344 100644 --- a/source/blender/python/mathutils/mathutils_Euler.c +++ b/source/blender/python/mathutils/mathutils_Euler.c @@ -774,9 +774,9 @@ PyDoc_STRVAR( "\n" " .. seealso:: `Euler angles <https://en.wikipedia.org/wiki/Euler_angles>`__ on Wikipedia.\n" "\n" - " :param angles: Three angles, in radians.\n" + " :arg angles: Three angles, in radians.\n" " :type angles: 3d vector\n" - " :param order: Optional order of the angles, a permutation of ``XYZ``.\n" + " :arg order: Optional order of the angles, a permutation of ``XYZ``.\n" " :type order: str\n"); PyTypeObject euler_Type = { PyVarObject_HEAD_INIT(NULL, 0) "Euler", /* tp_name */ diff --git a/source/blender/python/mathutils/mathutils_Matrix.c b/source/blender/python/mathutils/mathutils_Matrix.c index 8405b966a4e..af01c571fe9 100644 --- a/source/blender/python/mathutils/mathutils_Matrix.c +++ b/source/blender/python/mathutils/mathutils_Matrix.c @@ -3321,8 +3321,7 @@ PyDoc_STRVAR( " This object gives access to Matrices in Blender, supporting square and rectangular\n" " matrices from 2x2 up to 4x4.\n" "\n" - " :param rows: Sequence of rows.\n" - " When omitted, a 4x4 identity matrix is constructed.\n" + " :arg rows: Sequence of rows. When omitted, a 4x4 identity matrix is constructed.\n" " :type rows: 2d number sequence\n"); PyTypeObject matrix_Type = { PyVarObject_HEAD_INIT(NULL, 0) "Matrix", /*tp_name*/ diff --git a/source/blender/python/mathutils/mathutils_Quaternion.c b/source/blender/python/mathutils/mathutils_Quaternion.c index a5ea09bef48..d405d5e63ce 100644 --- a/source/blender/python/mathutils/mathutils_Quaternion.c +++ b/source/blender/python/mathutils/mathutils_Quaternion.c @@ -1662,9 +1662,9 @@ PyDoc_STRVAR(quaternion_doc, "\n" " This object gives access to Quaternions in Blender.\n" "\n" - " :param seq: size 3 or 4\n" + " :arg seq: size 3 or 4\n" " :type seq: :class:`Vector`\n" - " :param angle: rotation angle, in radians\n" + " :arg angle: rotation angle, in radians\n" " :type angle: float\n" "\n" " The constructor takes arguments in various forms:\n" diff --git a/source/blender/python/mathutils/mathutils_Vector.c b/source/blender/python/mathutils/mathutils_Vector.c index 0c9cbd6ccfa..cf684341d4f 100644 --- a/source/blender/python/mathutils/mathutils_Vector.c +++ b/source/blender/python/mathutils/mathutils_Vector.c @@ -3188,7 +3188,7 @@ PyDoc_STRVAR(vector_doc, "\n" " This object gives access to Vectors in Blender.\n" "\n" - " :param seq: Components of the vector, must be a sequence of at least two\n" + " :arg seq: Components of the vector, must be a sequence of at least two\n" " :type seq: sequence of numbers\n"); PyTypeObject vector_Type = { PyVarObject_HEAD_INIT(NULL, 0) |