Skip to content

Commit 90ad01c

Browse files
committed
docs: math.Vector2|3 zero vector normalisation raises
1 parent a966d54 commit 90ad01c

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

docs/reST/ref/math.rst

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -281,7 +281,8 @@ Conversion can be combined with swizzling or slicing to create a new order
281281
| :sg:`normalize() -> Vector2`
282282
283283
Returns a new vector that has ``length`` equal to ``1`` and the same
284-
direction as self.
284+
direction as self. If the vector is the zero vector (i.e. has length
285+
``0`` thus no direction) a ``ValueError`` is raised.
285286

286287
.. ## Vector2.normalize ##
287288
@@ -291,7 +292,9 @@ Conversion can be combined with swizzling or slicing to create a new order
291292
| :sg:`normalize_ip() -> None`
292293
293294
Normalizes the vector so that it has ``length`` equal to ``1``.
294-
The direction of the vector is not changed.
295+
The direction of the vector is not changed. If the vector is the zero
296+
vector (i.e. has length ``0`` thus no direction) a ``ValueError`` is
297+
raised.
295298

296299
.. ## Vector2.normalize_ip ##
297300
@@ -770,7 +773,8 @@ Conversion can be combined with swizzling or slicing to create a new order
770773
| :sg:`normalize() -> Vector3`
771774
772775
Returns a new vector that has ``length`` equal to ``1`` and the same
773-
direction as self.
776+
direction as self. If the vector is the zero vector (i.e. has length
777+
``0`` thus no direction) a ``ValueError`` is raised.
774778

775779
.. ## Vector3.normalize ##
776780
@@ -780,7 +784,8 @@ Conversion can be combined with swizzling or slicing to create a new order
780784
| :sg:`normalize_ip() -> None`
781785
782786
Normalizes the vector so that it has ``length`` equal to ``1``. The
783-
direction of the vector is not changed.
787+
direction of the vector is not changed. If the vector is the zero vector
788+
(i.e. has length ``0`` thus no direction) a ``ValueError`` is raised.
784789

785790
.. ## Vector3.normalize_ip ##
786791

0 commit comments

Comments
 (0)