Confusing/Misleading docstring for cartesian_to_spherical

[davidot]

I was using cartesian_to_spherical in space_ops.py but got confused by the docstring.
In there it says it returns (distance, phi, theta) however what the function calls phi and theta is not returned in that order.
Because both cartesian_to_spherical and spherical_to_cartesian use this order one can convert back and forth. See https://github.com/ManimCommunity/manim/blob/main/manim/utils/space_ops.py#L736-L776 .

However I think the order is confusing, or at least inconsistent with things like the value trackers of ThreeDCamera.

I'm not sure what the way to tackle issues like this is so although I initially wanted to submit a PR fixing the docstring I don't know if that is even correct anymore.

[Viicos]

Related: #2168 (and the related PR linked in this one). There's indeed a confusion in the docstring, coming from the fact that phi and theta don't represent the same angle if we are using math or physics convention

[chopan050]

There's indeed a confusion in the docstring, coming from the fact that phi and theta don't represent the same angle if we are using math or physics convention

A possible way to solve this is to refer to the docstring angles in a different way than phi or theta. Some options could be:

• (distance, azimuthal_angle, polar_angle)
• (distance, azimuthal, polar)
• (distance, xy_angle, z_angle) (my favorite one)

Whichever option is chosen, it would be nice if the variable names were also changed to match the docstring.