-
Notifications
You must be signed in to change notification settings - Fork 5
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
Update: Docs for release #36
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some suggested content changes :-)
The main fundamental difference is emphasising that the library implements a protocol for device types, not specific devices - i.e. there can be multiple different devices that fit within / make use of the message set for a particular device type (e.g. Ping and Ping2 are both Ping1D
type devices).
Thks @ES-Alexander, I really appreciate the suggestions. Now it's easier to navigate the documentation and their related devices. |
|
||
## Using example: | ||
[SONARs](https://en.wikipedia.org/wiki/Sonar), or **So**und **N**avigation **A**nd **R**anging devices, transmit sound waves and measure their reflections to detect surrounding obstacles and objects. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That would probably be [SoNARs]
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
https://bluerobotics.com/learn/understanding-and-using-scanning-sonars/#operating-principles
What about replace or
SONARs, from
Sound...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Usually only the first letter is capitalized. But no hard feelings. Once @ES-Alexander approves it we can merge.
Please check:
https://github.com/RaulTrombin/ping-rs/tree/Update_docs