From 4e9789ea1221cd02f9e5213b3c889eb16af0504f Mon Sep 17 00:00:00 2001 From: zzstoatzz Date: Mon, 1 Jun 2026 01:56:34 -0500 Subject: [PATCH] docs: explain supplemental test modules --- src/internal/repo/mst_test.zig | 7 ++++--- src/root.zig | 6 +++++- 2 files changed, 9 insertions(+), 4 deletions(-) diff --git a/src/internal/repo/mst_test.zig b/src/internal/repo/mst_test.zig index 88c6536..c6441dc 100644 --- a/src/internal/repo/mst_test.zig +++ b/src/internal/repo/mst_test.zig @@ -1,7 +1,8 @@ -//! additional MST tests ported from atmos (Go implementation). +//! supplemental MST tests ported from Atmos (Go implementation). //! -//! focuses on edge cases, stress tests, and compliance gaps not covered -//! by the inline tests in mst.zig. +//! mst.zig keeps inline tests near private helpers, reference fixtures, and +//! implementation-sensitive behavior. this file is the external suite for +//! black-box API behavior, stress cases, and compliance gaps. const std = @import("std"); const mst = @import("mst.zig"); diff --git a/src/root.zig b/src/root.zig index 6a73f20..b6539e7 100644 --- a/src/root.zig +++ b/src/root.zig @@ -68,7 +68,11 @@ pub const firehose = @import("internal/streaming/firehose.zig"); pub const FirehoseClient = firehose.FirehoseClient; pub const FirehoseEvent = firehose.Event; -// interop tests (test-only, references resolved by build.zig lazy dependency) +// Test-only imports: +// - inline tests in implementation files stay next to private helpers/fixtures +// - *_test.zig files are supplemental black-box, stress, and compliance suites +// that must be imported explicitly because Zig does not auto-discover tests +// - interop fixtures are resolved by build.zig's lazy dependency wiring comptime { if (@import("builtin").is_test) { _ = @import("internal/testing/interop_tests.zig"); -- 2.51.2