ManimCommunity/manim

Confusing/Misleading docstring for cartesian_to_spherical

Open

#3,123 创建于 2023年1月15日

在 GitHub 查看
 (2 评论) (0 反应) (0 负责人)Python (1,378 fork)batch import
good first issue

仓库指标

Star
 (17,820 star)
PR 合并指标
 (平均合并 90天 10小时) (30 天内合并 31 个 PR)

描述

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.

贡献者指南