Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document usage of kinematics in polar coordinates #160

Closed
niksirbi opened this issue Apr 9, 2024 · 0 comments · Fixed by #180
Closed

Document usage of kinematics in polar coordinates #160

niksirbi opened this issue Apr 9, 2024 · 0 comments · Fixed by #180
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@niksirbi
Copy link
Member

niksirbi commented Apr 9, 2024

PR #155 introduced kinematic variables in polar coordinates, and transformations between cartesian and polar coordinates. These features are being added to the API docs, but their usage is not yet documented in any example/tutorial.

Perhaps the best way to document this would be to amend the existing example about computing and visualising kinematics.

Alternatively, we could also split up the existing kinematics example into smaller bits (which ties into #70).

@niksirbi niksirbi added the documentation Improvements or additions to documentation label Apr 9, 2024
@niksirbi niksirbi mentioned this issue Apr 9, 2024
7 tasks
@sfmig sfmig mentioned this issue May 21, 2024
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Development

Successfully merging a pull request may close this issue.

2 participants