docs: Update MathComponent to Reference TestMain #1030
Merged
Conversation
This file contains 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
The existing MathComponent tutorial references a `main.cpp` test file that has been replaced by an autogenerated TestMain.cpp file. The docs have been updated to reference the TestMain file instead of the old manually created main.cpp file.
astroesteban
changed the title
|
@astroesteban thanks! I added a few more fixes w.r.t. TesterBase and GTestBase files being autocoded. |
|
Thanks for those extra fixes @LeStarch! |
|
@astroesteban you did the work, I was just cleaning up an old issue. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Change Description
The existing MathComponent unit test tutorial instructs the user to create a main.cpp test file even though running
fprime-util impl --utcreates a new TestMain.cpp file. The changes update the Tutorial.md file to reflect this new functionality and now instruct the user to modify the autogenerated TutorialMain.cpp file instead of creating a main.cpp file.In addition, the existing main.cpp files for the MathSender & MathReceiver components have been renamed to TestMain.cpp.
Rationale
Update the docs to reflect more features provided by
fprime-util impl --utTesting/Review Recommendations
maintoTestMain.Future Work