ManimCommunity/manim

Confusing/Misleading docstring for cartesian_to_spherical

Open

#3,123 opened on 2023年1月15日

GitHub で見る
 (2 comments) (0 reactions) (0 assignees)Python (17,820 stars) (1,378 forks)batch import
good first issue

説明

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.

コントリビューターガイド

技術スタック
python
領域
documentation
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
under 1 hour
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
basic Pythonunderstanding of coordinate systems
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
85
調査方針
The issue references the function in manim/utils/space ops.py (lines 736-776) and notes inconsistency with ThreeDCamera's value trackers in manim/camera/three d camera.py (line 87). First, read the docstring and implementation of cartesian to spherical to understand the current return order. Then, compare with the usage in three d camera.py to determine the expected order. Finally, update the docstring to accurately describe the return order, or if a deeper fix is needed, discuss in the issue before making changes.