Enhance documentation for test suites and utility functions

chrisreddington · Nov 18, 2024 · 7d3c224 · 7d3c224
1 parent 451a23b
commit 7d3c224
Show file tree

Hide file tree

Showing 5 changed files with 264 additions and 172 deletions.
diff --git a/__tests__/index.test.ts b/__tests__/index.test.ts
@@ -4,6 +4,10 @@ jest.mock('../src/main', () => ({
   run: jest.fn()
 }))
 
+/**
+ * Test suite for the GitHub Action's entry point.
+ * Validates that the action is properly initialized and the main run function is called.
+ */
 describe('index', () => {
   it('calls run when imported', async () => {
     await import('../src/index')