Docs: correct reference to types, remove redundant bpy.types prefix

This commit is contained in:
Campbell Barton
2023-06-14 12:20:09 +10:00
parent 47b52b39ac
commit 26b5de6865
+8 -9
View File
@@ -178,7 +178,7 @@ class Object(bpy_types.ID):
def children(self):
"""All the children of this object.
:type: tuple of `Object`
:type: tuple of :class:`Object`
.. note:: Takes ``O(len(bpy.data.objects))`` time."""
import bpy
@@ -189,7 +189,7 @@ class Object(bpy_types.ID):
def children_recursive(self):
"""A list of all children from this object.
:type: tuple of `Object`
:type: tuple of :class:`Object`
.. note:: Takes ``O(len(bpy.data.objects))`` time."""
import bpy
@@ -213,7 +213,7 @@ class Object(bpy_types.ID):
"""
The collections this object is in.
:type: tuple of `Collection`
:type: tuple of :class:`Collection`
.. note:: Takes ``O(len(bpy.data.collections) + len(bpy.data.scenes))`` time."""
import bpy
@@ -231,7 +231,7 @@ class Object(bpy_types.ID):
def users_scene(self):
"""The scenes this object is in.
:type: tuple of `Scene`
:type: tuple of :class:`Scene`
.. note:: Takes ``O(len(bpy.data.scenes) * len(bpy.data.objects))`` time."""
import bpy
@@ -788,15 +788,14 @@ class Gizmo(StructRNA):
# Convenience wrappers around private `_gpu` module.
def draw_custom_shape(self, shape, *, matrix=None, select_id=None):
"""
Draw a shape created form :class:`bpy.types.Gizmo.draw_custom_shape`.
Draw a shape created form :class:`Gizmo.draw_custom_shape`.
:arg shape: The cached shape to draw.
:type shape: Undefined.
:arg matrix: 4x4 matrix, when not given
:class:`bpy.types.Gizmo.matrix_world` is used.
:arg matrix: 4x4 matrix, when not given :class:`Gizmo.matrix_world` is used.
:type matrix: :class:`mathutils.Matrix`
:arg select_id: The selection id.
Only use when drawing within :class:`bpy.types.Gizmo.draw_select`.
Only use when drawing within :class:`Gizmo.draw_select`.
:type select_it: int
"""
import gpu
@@ -830,7 +829,7 @@ class Gizmo(StructRNA):
@staticmethod
def new_custom_shape(type, verts):
"""
Create a new shape that can be passed to :class:`bpy.types.Gizmo.draw_custom_shape`.
Create a new shape that can be passed to :class:`Gizmo.draw_custom_shape`.
:arg type: The type of shape to create in (POINTS, LINES, TRIS, LINE_STRIP).
:type type: string