commit f9c64d17a7d4f506eb7501a85a0f43eef969c0e5
author Wyatt Hepler <hepler@google.com> Fri Jan 03 17:26:17 2020 -0800
committer Wyatt Hepler <hepler@google.com> Fri Jan 03 17:29:16 2020 -0800
tree ecd9c5158f9eef420f36aff09730cc8371c43fd9
parent 2f8851695d8285393f8f44d190b88dea08d3d303

pw_unit_test: Add comment to unit test

Change-Id: I967eb7329e5691725711f82c7f7a206dcd292243

pw_unit_test/framework_test.cc

diff --git a/pw_unit_test/framework_test.cc b/pw_unit_test/framework_test.cc
index 2b16b37..2d570ee 100644
--- a/pw_unit_test/framework_test.cc
+++ b/pw_unit_test/framework_test.cc
@@ -67,9 +67,11 @@
   ASSERT_STRNE("yes", no);
 }
 
-TEST(PigweedTest, ExpectSucceedFail) {
+TEST(PigweedTest, SucceedAndFailMacros) {
   SUCCEED();
 
+  // The ADD_FAILURE() and FAIL() macros cause a test to fail if they are
+  // reached. Use them, but don't let them run so that this test still passes.
   if (false) {
     ADD_FAILURE();
     FAIL();