From 1c92d26bfc8d89399edab2d3c3f75bec0533b1ba Mon Sep 17 00:00:00 2001 From: Nathan Burnham Date: Tue, 4 Jun 2024 15:40:57 +0000 Subject: [PATCH] PyAPI Doc: fix typos causing untyped parameters The type for `bpy_struct.keyframe_insert()`'s `options` parameter was instead applied to a non-existent `flag` parameter. The description and type for `mathutils.Vector.Repeat()`'s `vector` parameter was instead applied to a non-existent `tuple` parameter. Also fix a reference to `BMElemeSeq` instead of `BMElemSeq`. Ref: !122734 --- source/blender/python/bmesh/bmesh_py_types.cc | 2 +- source/blender/python/intern/bpy_rna_anim.cc | 2 +- source/blender/python/mathutils/mathutils_Vector.cc | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/source/blender/python/bmesh/bmesh_py_types.cc b/source/blender/python/bmesh/bmesh_py_types.cc index 0737f39a77e..ceea90d2090 100644 --- a/source/blender/python/bmesh/bmesh_py_types.cc +++ b/source/blender/python/bmesh/bmesh_py_types.cc @@ -2912,7 +2912,7 @@ PyDoc_STRVAR( ".. method:: sort(key=None, reverse=False)\n" "\n" " Sort the elements of this sequence, using an optional custom sort key.\n" - " Indices of elements are not changed, BMElemeSeq.index_update() can be used for that.\n" + " Indices of elements are not changed, :class:`BMElemSeq.index_update` can be used for that.\n" "\n" " :arg key: The key that sets the ordering of the elements.\n" " :type key: :function: returning a number\n" diff --git a/source/blender/python/intern/bpy_rna_anim.cc b/source/blender/python/intern/bpy_rna_anim.cc index ad77f89c82a..e1d6942deba 100644 --- a/source/blender/python/intern/bpy_rna_anim.cc +++ b/source/blender/python/intern/bpy_rna_anim.cc @@ -319,7 +319,7 @@ char pyrna_struct_keyframe_insert_doc[] = " - ``INSERTKEY_AVAILABLE`` Only insert into already existing F-Curves.\n" " - ``INSERTKEY_CYCLE_AWARE`` Take cyclic extrapolation into account " "(Cycle-Aware Keying option).\n" - " :type flag: set\n" + " :type options: set\n" " :arg keytype: Type of the key: 'KEYFRAME', 'BREAKDOWN', 'MOVING_HOLD', 'EXTREME', " "'JITTER', or 'GENERATED'\n" " :type keytype: string\n" diff --git a/source/blender/python/mathutils/mathutils_Vector.cc b/source/blender/python/mathutils/mathutils_Vector.cc index 94e8e0b0ea7..0583f6ac3d7 100644 --- a/source/blender/python/mathutils/mathutils_Vector.cc +++ b/source/blender/python/mathutils/mathutils_Vector.cc @@ -354,8 +354,8 @@ PyDoc_STRVAR( "\n" " Create a vector by repeating the values in vector until the required size is reached.\n" "\n" - " :arg tuple: The vector to draw values from.\n" - " :type tuple: :class:`mathutils.Vector`\n" + " :arg vector: The vector to draw values from.\n" + " :type vector: :class:`mathutils.Vector`\n" " :arg size: The size of the vector to be created.\n" " :type size: int\n"); static PyObject *C_Vector_Repeat(PyObject *cls, PyObject *args)