add go doc to test

CI was complaining about missing comments on the new test function. It feels a bit silly to require this of tests but whatever XD
hashicorp · Nov 22, 2024 · b0b266a · b0b266a
1 parent d93be1a
commit b0b266a
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/helper/trace/debug_trace_test.go b/helper/trace/debug_trace_test.go
@@ -12,6 +12,8 @@ import (
 	"github.com/stretchr/testify/require"
 )
 
+// TestStartDebugTrace tests the debug trace functionality creating real
+// files and traces.
 func TestStartDebugTrace(t *testing.T) {
 	t.Run("error_on_non_existent_dir", func(t *testing.T) {
 		_, _, err := StartDebugTrace("non-existent-dir", "filePrefix")