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.
This commit is contained in:
@@ -416,7 +416,10 @@ def main():
|
||||
fw(" **type** {:s}\n".format(tp))
|
||||
|
||||
fw("\n")
|
||||
fw(" :rtype: dict with string keys\n")
|
||||
# TODO: Any is not quite correct here,
|
||||
# the exact type depends on output args used by BMesh.
|
||||
# This should really be a type alias.
|
||||
fw(" :rtype: dict[str, Any]\n")
|
||||
|
||||
fw("\n\n")
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ 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: string
|
||||
:type: str
|
||||
""")
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user