You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Users learning about Ignition Math should be able to refer to simple examples to learn how to use the APIs. The closes to that we have are the unit tests. We should have examples in C++, as well as any scripting languages that we support (currently Ruby and Python).
Alternatives considered
Tell users to look at unit tests.
Implementation suggestion
Add examples to the examples folder. The example should then be used as a doxygen \snippet in the class's doxygen description. For example:
Desired behavior
Users learning about Ignition Math should be able to refer to simple examples to learn how to use the APIs. The closes to that we have are the unit tests. We should have examples in C++, as well as any scripting languages that we support (currently Ruby and Python).
Alternatives considered
Tell users to look at unit tests.
Implementation suggestion
Add examples to the examples folder. The example should then be used as a doxygen
\snippet
in the class's doxygen description. For example:https://github.com/ignitionrobotics/ign-math/blob/d338701cd27c172aa931634335024f4c68c78e2c/include/ignition/math/Angle.hh#L60
See how it's rendered here: https://ignitionrobotics.org/api/math/6.9/classignition_1_1math_1_1Angle.html#details
Each example can be added in a separate pull request. This is a great issue for first-time contributors!
Here's the status:
Additional context
This was broken off #101
The text was updated successfully, but these errors were encountered: