[Bf-blender-cvs] [695e025c82a] master: Docs: Fix minor incorrect syntax errors

nutti noreply at git.blender.org
Thu Jul 8 01:42:04 CEST 2021


Commit: 695e025c82ab3ea72a4eb8f0eb11bc7af4954d29
Author: nutti
Date:   Wed Jul 7 19:41:15 2021 -0400
Branches: master
https://developer.blender.org/rB695e025c82ab3ea72a4eb8f0eb11bc7af4954d29

Docs: Fix minor incorrect syntax errors

This patch fixes the incorrect syntax in documentations.

Reviewed By: Blendify

Differential Revision: https://developer.blender.org/D11822

===================================================================

M	source/blender/python/gpu/gpu_py_uniformbuffer.c
M	source/blender/python/intern/bpy_rna_id_collection.c
M	source/blender/python/intern/bpy_utils_previews.c
M	source/blender/python/mathutils/mathutils_Vector.c

===================================================================

diff --git a/source/blender/python/gpu/gpu_py_uniformbuffer.c b/source/blender/python/gpu/gpu_py_uniformbuffer.c
index edcec486398..cfef20e2e4d 100644
--- a/source/blender/python/gpu/gpu_py_uniformbuffer.c
+++ b/source/blender/python/gpu/gpu_py_uniformbuffer.c
@@ -104,7 +104,7 @@ static PyObject *pygpu_uniformbuffer__tp_new(PyTypeObject *UNUSED(self),
 }
 
 PyDoc_STRVAR(pygpu_uniformbuffer_update_doc,
-             ".. method::update(data)\n"
+             ".. method:: update(data)\n"
              "\n"
              "   Update the data of the uniform buffer object.\n");
 static PyObject *pygpu_uniformbuffer_update(BPyGPUUniformBuf *self, PyObject *obj)
diff --git a/source/blender/python/intern/bpy_rna_id_collection.c b/source/blender/python/intern/bpy_rna_id_collection.c
index ac061c3dd60..66044311321 100644
--- a/source/blender/python/intern/bpy_rna_id_collection.c
+++ b/source/blender/python/intern/bpy_rna_id_collection.c
@@ -130,7 +130,7 @@ static int foreach_libblock_id_user_map_callback(LibraryIDLinkCallbackData *cb_d
 }
 
 PyDoc_STRVAR(bpy_user_map_doc,
-             ".. method:: user_map([subset=(id1, id2, ...)], key_types={..}, value_types={..})\n"
+             ".. method:: user_map(subset, key_types, value_types)\n"
              "\n"
              "   Returns a mapping of all ID data-blocks in current ``bpy.data`` to a set of all "
              "datablocks using them.\n"
@@ -277,7 +277,7 @@ error:
 }
 
 PyDoc_STRVAR(bpy_batch_remove_doc,
-             ".. method:: batch_remove(ids=(id1, id2, ...))\n"
+             ".. method:: batch_remove(ids)\n"
              "\n"
              "   Remove (delete) several IDs at once.\n"
              "\n"
diff --git a/source/blender/python/intern/bpy_utils_previews.c b/source/blender/python/intern/bpy_utils_previews.c
index 7a826d99a3d..6a46d2a1a96 100644
--- a/source/blender/python/intern/bpy_utils_previews.c
+++ b/source/blender/python/intern/bpy_utils_previews.c
@@ -59,7 +59,6 @@ PyDoc_STRVAR(
     "   :type name: string\n"
     "   :return: The Preview matching given name, or a new empty one.\n"
     "   :rtype: :class:`bpy.types.ImagePreview`\n"
-    "   :rtype: :class:`bpy.types.ImagePreview`\n"
     /* This is only true when accessed via 'bpy.utils.previews.ImagePreviewCollection.load',
      * however this is the public API, allow this minor difference to the internal version here. */
     "   :raises KeyError: if ``name`` already exists.");
diff --git a/source/blender/python/mathutils/mathutils_Vector.c b/source/blender/python/mathutils/mathutils_Vector.c
index 4ad0264582f..c2223b023ad 100644
--- a/source/blender/python/mathutils/mathutils_Vector.c
+++ b/source/blender/python/mathutils/mathutils_Vector.c
@@ -149,7 +149,7 @@ static PyObject *C_Vector_Fill(PyObject *cls, PyObject *args)
 }
 
 PyDoc_STRVAR(C_Vector_Range_doc,
-             ".. classmethod:: Range(start=0, stop, step=1)\n"
+             ".. classmethod:: Range(start, stop, step=1)\n"
              "\n"
              "   Create a filled with a range of values.\n"
              "\n"



More information about the Bf-blender-cvs mailing list