Test file location wasn't clear, added example file tree #4179
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
I also changed the names to match the example file tree Signed-off-by: Jakeisthesnake <[email protected]>
fujitatomoya
approved these changes
Feb 20, 2024
Collaborator
fujitatomoya
left a comment
fujitatomoya
left a comment
There was a problem hiding this comment.
lgtm with a few minor nits. thanks for creating PR.
| Source Code | ||
| ^^^^^^^^^^^ | ||
| We'll start off with our code in a file called ``test/tutorial_test.cpp`` | ||
| We'll start off with our code in a file called ``<your_package>/test/tutorial_test.cpp`` |
Collaborator
There was a problem hiding this comment.
https://docs.ros.org/en/rolling/Tutorials/Beginner-Client-Libraries/Creating-Your-First-ROS2-Package.html#createpkg uses my_package, would be nice if we use that here as well.
Suggested change
| We'll start off with our code in a file called ``<your_package>/test/tutorial_test.cpp`` | |
| We'll start off with our code in a file called ``my_package/test/tutorial_test.cpp`` |
| #include <gtest/gtest.h> | ||
|
|
||
| TEST(package_name, a_first_test) | ||
| TEST(<your_package>, a_first_test) |
Collaborator
There was a problem hiding this comment.
Suggested change
| TEST(<your_package>, a_first_test) | |
| TEST(my_package, a_first_test) |
|
|
||
| .. code-block:: | ||
| <your_workspace>/src/<your_package>/ |
Collaborator
There was a problem hiding this comment.
Suggested change
| <your_workspace>/src/<your_package>/ | |
| workspace_folder/src/my_package/ |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
[I am a beginner with ROS, but from what I could gather by looking at other repositories, the test files go in the root of the package directory. Please reject this pull request if that isn't accurate. Or leave feedback and I can correct it.]
I also changed the names to match the example file tree.
One example of where test files are stored in another repository.
https://github.com/ros2/geometry2/tree/rolling/tf2