PyAPI Doc: fix typos causing untyped parameters
Some checks failed
buildbot/vdev-code-daily-linux-x86_64 Build done.
buildbot/vdev-code-daily-lint Build done.
buildbot/vdev-code-daily-darwin-x86_64 Build done.
buildbot/vdev-code-daily-windows-amd64 Build done.
buildbot/vdev-code-daily-darwin-arm64 Build done.
buildbot/vdev-code-daily-coordinator Build done.

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
This commit is contained in:
Nathan Burnham 2024-06-04 15:40:57 +00:00 committed by Campbell Barton
parent 8719057b4a
commit 1c92d26bfc
3 changed files with 4 additions and 4 deletions

View File

@ -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"

View File

@ -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"

View File

@ -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)