adding basic usage to description #18
Conversation
tfoote
added
in progress
|
I think putting documentation like this into the package manifest will not be discoverable by users. That would be the last location I would look for information like this. I would propose to either create a |
|
As someone entering a ROS codebase for the first time, my entry point is always the package.xml/manifest.xml. Although it is basically API/usage documentation we do not have any standard location for that yet. The official package description is much more visible than a random markdown file embedded inside a package. Longer term I agree we should move it out into documentation. But since this package doesn't have even a full paragraph description I think it's more useful to new users browsing the packages to find this when they look for the description. It make it very clear what the package does and how to use it instead of a very abstract single sentence summary. |
|
+1 |
|
After discussing it we will put it in a markdown file in the |
tfoote
force-pushed
the
gtest_docs
branch
2 times, most recently
from
f2a7abb
to
4bd7087
Compare
|
Updated to be in markdown in doc folder |
|
|
||
| To use this package do the following things. | ||
| - add a test dependency to your packages.xml: `<test_depend>ament_cmake_gtest</test_depend>` | ||
| - Write a gtest executable: Use `#include "gtest/gtest.h"` and standard gtest methods. |
There was a problem hiding this comment.
Use #include <...> instead.
|
typos fixed |
|
+1 |
adding basic usage to description
Connects to ros2/ros2#76