PyDoc: correct operator links, use :func: instead of :mod:

This commit is contained in:
Campbell Barton 2026-02-16 18:07:30 +11:00
parent 57d607f680
commit 76976a676a
2 changed files with 7 additions and 5 deletions

View file

@ -61,10 +61,10 @@ modifier or constraint.
Examples of this are:
- :mod:`bpy.ops.texture.slot_move`
- :mod:`bpy.ops.constraint.limitdistance_reset`
- :mod:`bpy.ops.object.modifier_copy`
- :mod:`bpy.ops.buttons.file_browse`
- :func:`bpy.ops.texture.slot_move`
- :func:`bpy.ops.constraint.limitdistance_reset`
- :func:`bpy.ops.object.modifier_copy`
- :func:`bpy.ops.buttons.file_browse`
Another possibility is that you are the first person to attempt to use this operator
in a script and some modifications need to be made to the operator to run in a different context.

View file

@ -1585,7 +1585,9 @@ def pyrna2sphinx(basepath):
# way to construct this data type, so - coercing them from a `dict` is supported.
# Since this is a special case in the RNA API, we need to override the type.
# Link to the operator to find the supported arguments.
type_info.append(":mod:`bpy.ops.{:s}` keyword arguments".format(format_operator_as_module(prop.identifier)))
type_info.append(
":func:`bpy.ops.{:s}` keyword arguments".format(format_operator_as_module(prop.identifier)),
)
type_descr = "dict[str, Any]"
prop_name = prop.name