archive/blender-archive
Archived
1
1
Fork 0
Code Pull Requests Packages Activity

Docs: Fixes and improvements in API documentation

Browse Source 
Fixes several notable mistakes and missing information
regarding the API documentation (*.rst).

This will allow API stub generators like bpystubgen or
fake-bpy-module to produce more accurate result.

Differential Revision: https://developer.blender.org/D12639
This commit is contained in:
Xavier Cho
2021-10-22 18:27:03 -04:00
committed by Aaron Carlisle
parent 1d9e2dc954
commit 62d64bec2a
6 changed files with 62 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
source/blender/python/generic/bl_math_py_api.c
View File

@@ -77,14 +77,14 @@ static PyObject *py_bl_math_clamp(PyObject *UNUSED(self), PyObject *args)
}
PyDoc_STRVAR(py_bl_math_lerp_doc,
".. function:: lerp(from, to, factor)\n"
".. function:: lerp(from_value, to_value, factor)\n"
"\n"
" Linearly interpolate between two float values based on factor.\n"
"\n"
" :arg from: The value to return when factor is 0.\n"
" :type from: float\n"
" :arg to: The value to return when factor is 1.\n"
" :type to: float\n"
" :arg from_value: The value to return when factor is 0.\n"
" :type from_value: float\n"
" :arg to_value: The value to return when factor is 1.\n"
" :type to_value: float\n"
" :arg factor: The interpolation value, normally in [0.0, 1.0].\n"
" :type factor: float\n"
" :return: The interpolated value.\n"
@@ -101,15 +101,15 @@ static PyObject *py_bl_math_lerp(PyObject *UNUSED(self), PyObject *args)
PyDoc_STRVAR(
py_bl_math_smoothstep_doc,
".. function:: smoothstep(from, to, value)\n"
".. function:: smoothstep(from_value, to_value, value)\n"
"\n"
" Performs smooth interpolation between 0 and 1 as value changes between from and to.\n"
" Performs smooth interpolation between 0 and 1 as value changes between from and to values.\n"
" Outside the range the function returns the same value as the nearest edge.\n"
"\n"
" :arg from: The edge value where the result is 0.\n"
" :type from: float\n"
" :arg to: The edge value where the result is 1.\n"
" :type to: float\n"
" :arg from_value: The edge value where the result is 0.\n"
" :type from_value: float\n"
" :arg to_value: The edge value where the result is 1.\n"
" :type to_value: float\n"
" :arg factor: The interpolation value.\n"
" :type factor: float\n"
" :return: The interpolated value in [0.0, 1.0].\n"