PyDoc: improve mathutils python signatures and doc-strings

- Adding `/` to signatures to indicate that arguments are accepted only
  as positional.
- Document default values and optional arguments in consistent way with
  other docs.
- Use `Literal` for strings to indicate set of allowed string values
  (later it can also be used in typing stubs).
- Document some undocumented arguments.

Ref !143278
This commit is contained in:
Andrej730
2025-07-20 17:18:26 +05:00
committed by Campbell Barton
parent 895189dd19
commit ddeddaecd6
10 changed files with 149 additions and 129 deletions

View File

@@ -402,6 +402,9 @@ PyDoc_STRVAR(
py_KDtree_doc,
"KdTree(size) -> new kd-tree initialized to hold ``size`` items.\n"
"\n"
" :arg size: Number of items.\n"
" :type size: int\n"
"\n"
".. note::\n"
"\n"
" :class:`KDTree.balance` must have been called before using any of the ``find`` "