Skip to content

Commit

Permalink
Test doco update
Browse files Browse the repository at this point in the history
  • Loading branch information
peteGSX committed Jan 6, 2025
1 parent e5a31dc commit 3843d24
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions EX-Display.ino
Original file line number Diff line number Diff line change
Expand Up @@ -80,11 +80,11 @@
* these. Also note the mention of needing include guards for this as per @ref adding_types.
*
* All tests are run when pushing or merging to both the main and devel branches, and can be run locally with PlatformIO
* also:
* also using the following commands. The verbose output is recommended to review the test output.
*
* @code
* pio test -e native_test
* pio test -e native_test_windows
* pio test -e native_test -v
* pio test -e native_test_windows -v
* @endcode
*
* Note that due to issues with the sanitizers that check from memory leaks and undefined references not being available
Expand All @@ -95,6 +95,14 @@
* The best approach when adding new functionality is to write the test first, and then ensure the code to support the
* feature makes the test succeed.
*
* When writing and running tests, cleaning up between test runs is often required, and is recommended to be done prior
* to pushing to the main or devel branches just to ensure all is good. This can be done with this command:
*
* @code
* pio run -t clean -e native_test
* pio run -t clean -e native_test_windows
* @endcode
*
* @section adding_types Adding Display and Input Types
* As mentioned in the @ref application_architecture, both displays and inputs are derived from the appropriate
* interface class to enable multiple different types to be made available for users to configure and use.
Expand Down

0 comments on commit 3843d24

Please sign in to comment.