ManimCommunity/manim

Confusing/Misleading docstring for cartesian_to_spherical

Open

#3.123 geöffnet am 15. Jan. 2023

Auf GitHub ansehen
 (2 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (1.378 Forks)batch import
good first issue

Repository-Metriken

Stars
 (17.820 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 11T 17h) (4 gemergte PRs in 30 T)

Beschreibung

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.

Contributor Guide

Research-Richtung
Das Issue verweist auf die Funktion in manim/utils/space ops.py (Zeilen 736-776) und stellt eine Inkonsistenz mit den Value Trackern von ThreeDCamera in manim/camera/three d camera.py (Zeile 87) fest. Lies zunächst den Docstring und die Implementierung von cartesian to spherical, um die aktuelle Rückgabereihenfolge zu verstehen. Vergleiche dann mit der Verwendung in three d camera.py, um die erwartete Reihenfolge zu bestimmen. Aktualisiere schließlich den Docstring, um die Rückgabereihenfolge genau zu beschreiben, oder falls eine tiefergehende Korrektur erforderlich ist, diskutiere dies im Issue, bevor du Änderungen vornimmst.
Tech Stack
python
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
basic Pythonunderstanding of coordinate systems
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85