Skip to content

Commit 72a6719

Browse files
committed
Updated docs to fix stubs and clarify docs a bit
1 parent 631cab3 commit 72a6719

File tree

2 files changed

+10
-6
lines changed

2 files changed

+10
-6
lines changed

docs/reST/ref/math.rst

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -391,7 +391,9 @@ Conversion can be combined with swizzling or slicing to create a new order
391391
Returns a Vector which is a linear interpolation between self and the
392392
given Vector. The second parameter determines how far between self and
393393
other the result is going to be. It must be a value between ``0`` and ``1``
394-
where ``0`` means self and ``1`` means other will be returned.
394+
when ``do_clamp`` is ``True`` where ``0`` means self and ``1`` means other
395+
will be returned. When ``do_clamp`` is ``False``, the lerp will extend out
396+
linearly when the second parameter is outside of the nominal range.
395397

396398
.. versionchanged:: 2.5.7 The ``do_clamp`` parameter is added with a default
397399
value of ``True``. When it's ``True``, the second parameter is limited
@@ -881,12 +883,14 @@ Conversion can be combined with swizzling or slicing to create a new order
881883

882884
| :sl:`returns a linear interpolation to the given vector.`
883885
| :sg:`lerp(Vector3, float, /) -> Vector3`
884-
| :sg:`lerp(Vector3, float, bool, /)`
886+
| :sg:`lerp(Vector3, float, bool, /) -> Vector3`
885887
886888
Returns a Vector which is a linear interpolation between self and the
887-
given Vector. The second parameter determines how far between self an
888-
other the result is going to be. It must be a value between ``0`` and
889-
``1``, where ``0`` means self and ``1`` means other will be returned.
889+
given Vector. The second parameter determines how far between self and
890+
other the result is going to be. It must be a value between ``0`` and ``1``
891+
when ``do_clamp`` is ``True`` where ``0`` means self and ``1`` means other
892+
will be returned. When ``do_clamp`` is ``False``, the lerp will extend out
893+
linearly when the second parameter is outside of the nominal range.
890894

891895
.. versionchanged:: 2.5.7 The ``do_clamp`` parameter is added with a default
892896
value of ``True``. When it's ``True``, the second parameter is limited

src_c/doc/math_doc.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@
5959
#define DOC_MATH_VECTOR3_DISTANCESQUAREDTO "distance_squared_to(Vector3, /) -> float\ncalculates the squared Euclidean distance to a given vector."
6060
#define DOC_MATH_VECTOR3_MOVETOWARDS "move_towards(Vector3, float, /) -> Vector3\nreturns a vector moved toward the target by a given distance."
6161
#define DOC_MATH_VECTOR3_MOVETOWARDSIP "move_towards_ip(Vector3, float, /) -> None\nmoves the vector toward its target at a given distance."
62-
#define DOC_MATH_VECTOR3_LERP "lerp(Vector3, float, /) -> Vector3\nreturns a linear interpolation to the given vector."
62+
#define DOC_MATH_VECTOR3_LERP "lerp(Vector3, float, /) -> Vector3\nlerp(Vector3, float, bool, /) -> Vector3\nreturns a linear interpolation to the given vector."
6363
#define DOC_MATH_VECTOR3_SLERP "slerp(Vector3, float, /) -> Vector3\nreturns a spherical interpolation to the given vector."
6464
#define DOC_MATH_VECTOR3_SMOOTHSTEP "smoothstep(Vector3, float, /) -> Vector3\nreturns a smooth interpolation to the given vector."
6565
#define DOC_MATH_VECTOR3_ELEMENTWISE "elementwise() -> VectorElementwiseProxy\nThe next operation will be performed elementwise."

0 commit comments

Comments
 (0)