Update README.md and comments

elliot-zzh · Feb 3, 2023 · ac11f91 · ac11f91
1 parent b77b037
commit ac11f91
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -231,7 +231,7 @@ Also an extension for converting command line arguments to **Lightest** configur
 * `--no-output` or `-no` to disable default outputs.
 * `--return-zero`, `--return-0` or `-r0` to disable returning 1 when failing.
 
-### To analyze data yourself
+### Data analysis
 
 An extension for convenient data analysis and beautiful total report is provided. Just include `lightest/data_analysis_ext.h` to use it. Here is an example of using this extension:
 
@@ -243,9 +243,10 @@ TEST(TestPass) { REQ(1, ==, 1); }
 TEST(TestFail) { REQ(1, ==, 2); }
 
 REPORT() {
-  // currently provide these 2 options
-  REPORT_FAILED_TESTS();
-  REPORT_PASS_RATE();
+  // currently provide these 3 options
+  REPORT_FAILED_TESTS(); // List all failed test, sub tests outputted with tabs
+  REPORT_PASS_RATE(); // Calculate the passing rate of global tests
+  REPORT_AVG_TIME(); // Report average time use of global tests
 }
 ```
 

diff --git a/include/lightest/data_analysis_ext.h b/include/lightest/data_analysis_ext.h
@@ -60,7 +60,7 @@ void IterFailedTests(const DataSet* data, function<void(const DataSet*)> func) {
   } while (0)
 
 // Calculate passing rate and also report the numbers of failed, passed, and
-// total tests
+// total tests (just include global tests)
 #define REPORT_PASS_RATE()                                                   \
   do {                                                                       \
     unsigned int failedTestCount = 0;                                        \
@@ -79,6 +79,7 @@ void IterFailedTests(const DataSet* data, function<void(const DataSet*)> func) {
     std::cout << std::endl;                                                  \
   } while (0)
 
+// Calculate & report the average time of global tests
 #define REPORT_AVG_TIME()                                                    \
   do {                                                                       \
     clock_t timeSum = 0;                                                     \