blender/doc/python_api/sphinx_doc_gen_monkeypatch.py
Campbell Barton 3bcfb151c1 PyDoc: use Python's type annotation syntax for doc-strings
Replace plain-text type information with the type syntax used
for Python's type annotations as it's more concise, especially for
callbacks which often didn't include useful type information.

Note that this change only applies to inline doc-strings,
generated doc-strings from RNA need to be updated separately.

Details:

- Many minor corrections were made when "list" was incorrectly used
  instead of "sequence".
- Some type information wasn't defined in the doc-strings and has been
  added.
- Verbose type info would benefit from support for type aliases.
2024-11-03 15:44:35 +11:00

30 lines
742 B
Python

# SPDX-FileCopyrightText: 2009-2022 Blender Authors
#
# SPDX-License-Identifier: GPL-2.0-or-later
bpy_types_Operator_bl_property__doc__ = (
"""
The name of a property to use as this operators primary property.
Currently this is only used to select the default property when
expanding an operator into a menu.
:type: str
""")
def main():
import bpy
from bpy.types import Operator
def dummy_func(test):
pass
kw_dummy = dict(fget=dummy_func, fset=dummy_func, fdel=dummy_func)
# bpy registration handles this,
# but its only checked for and not existing in the base class.
Operator.bl_property = property(doc=bpy_types_Operator_bl_property__doc__, **kw_dummy)
if __name__ == "__main__":
main()