search

USC-ACTLab / crazyswarm

A Large Quadcopter Swarm
MIT License
325 stars 318 forks source link

Improve documentation on goTo vs. cmdPosition #540

Closed jpreiss closed 2 years ago

jpreiss commented 2 years ago

Users are often confused when choosing between goTo and cmdPosition. Examples:

https://github.com/USC-ACTLab/crazyswarm/discussions/530 https://github.com/USC-ACTLab/crazyswarm/discussions/466 https://github.com/USC-ACTLab/crazyswarm/discussions/388 https://github.com/USC-ACTLab/crazyswarm/discussions/341 https://github.com/USC-ACTLab/crazyswarm/issues/117#issuecomment-438792504 https://github.com/USC-ACTLab/crazyswarm/issues/92 https://github.com/USC-ACTLab/crazyswarm/issues/54

We should improve the documentation so that each method's docstring mentions the appropriate use cases vs. the other command. (Maybe cmdFullState should be included too?)