Fix docstring for cartesian_to_spherical to match return order#4823
Open
daudibrahimhasan wants to merge 2 commits into
Open
Fix docstring for cartesian_to_spherical to match return order#4823daudibrahimhasan wants to merge 2 commits into
daudibrahimhasan wants to merge 2 commits into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Overview: What does this pull request change?
Fixes the misleading docstring for
cartesian_to_sphericalinmanim/utils/space_ops.py.The docstring stated the return value as
(distance, phi, theta), but the function actually returns[r, theta, phi]. This updates the docstring to match the implementation and adds aReturnssection describing each value,consistent with the documentation of
spherical_to_cartesian.Closes #3123
Motivation and Explanation: Why and how do your changes improve the library?
The previous docstring listed the coordinates in the wrong order, which is confusing for anyone using the function
(the issue reporter ran into exactly this). Correcting it — and documenting what each returned value means — removes
the inconsistency and makes the function's behaviour clear without needing to read the source.
Links to added or changed documentation pages
N/A — this is an in-code docstring fix only.
Further Information and Comments
Documentation-only change; no functional code was modified.