From 7e18862cdd4fdd4ec1ebd152977eb20c4f0e984a Mon Sep 17 00:00:00 2001
From: Jeremy Wall <jeremy@marzhillstudios.com>
Date: Tue, 2 Apr 2024 19:46:14 -0400
Subject: [PATCH] docs: Export and document summarize function

---
 src/TAP.mjs | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/src/TAP.mjs b/src/TAP.mjs
index 81070c4..a1b9f12 100644
--- a/src/TAP.mjs
+++ b/src/TAP.mjs
@@ -384,6 +384,11 @@ function runTest(t, testName, test) {
     return t;
 }
 
+/**
+ * Output a summary of the tests as comments.
+ *
+ * @param {Tap} t 
+ */
 function summarize(t) {
     if (t.planned > t.counter) {
         t.comment('looks like you planned ' + t.planned + ' tests but only ran '
@@ -413,5 +418,5 @@ function runSuite(t, suite) {
     summarize(t);
 }
 
-export { Tap, runTest, runSuite, BrowserRenderer, NodeRenderer };
+export { Tap, runTest, runSuite, summarize, BrowserRenderer, NodeRenderer };