Fix docstring for cartesian_to_spherical to match return order

This commit is contained in:
Daud Ibrahim Hassan 2026-06-21 01:11:53 +06:00 committed by GitHub
commit 77636c06c1
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -809,21 +809,25 @@ def earclip_triangulation(verts: np.ndarray, ring_ends: list) -> list:
def cartesian_to_spherical(vec: Vector3DLike) -> np.ndarray:
"""Returns an array of numbers corresponding to each
polar coordinate value (distance, phi, theta).
"""Returns an array of numbers corresponding to each
spherical coordinate value (distance, theta, phi).
Parameters
----------
vec
A numpy array or a sequence of floats ``[x, y, z]``.
"""
norm = np.linalg.norm(vec)
if norm == 0:
return np.zeros(3)
r = norm
phi = np.arccos(vec[2] / r)
theta = np.arctan2(vec[1], vec[0])
return np.array([r, theta, phi])
Parameters
----------
vec
A numpy array or a sequence of floats ``[x, y, z]``.
Returns
-------
:class:`numpy.ndarray`
An array of three floats ``[r, theta, phi]`` where:
r - The distance between the point and the origin.
theta - The azimuthal angle of the point to the positive x-axis.
phi - The vertical angle of the point to the positive z-axis.
"""
def spherical_to_cartesian(spherical: Sequence[float]) -> np.ndarray: