From 2b88c6a83f854c3e166774d2855491de6e230d03 Mon Sep 17 00:00:00 2001 From: Craig Jennings Date: Mon, 11 May 2026 18:17:22 -0500 Subject: docs: clarify the coverage-exclude and token-seed comments The Makefile's `COVERAGE_EXCLUDE' comment said why `test-all-comp-errors.el' is excluded but not why `test-lorem-optimum-benchmark.el' is. It now notes that undercover's instrumentation slows execution enough to fail the benchmark's wall-clock assertions. And `cj/markov-generate' now has a comment explaining why `tokens' is seeded reversed (`(list w2 w1)'): the list is built with `push' and `nreverse'd at the end, so without the note the reversed seed reads like a bug at a glance. --- Makefile | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'Makefile') diff --git a/Makefile b/Makefile index 5e35a4cc..3b5d9024 100644 --- a/Makefile +++ b/Makefile @@ -228,8 +228,9 @@ COVERAGE_DIR = .coverage COVERAGE_FILE = $(COVERAGE_DIR)/simplecov.json # Test files that can't coexist with undercover's instrumentation -# (e.g. test-all-comp-errors byte-compiles modules, which fails on -# instrumented sources). Excluded from `make coverage' only. +# (test-all-comp-errors byte-compiles modules, which fails on instrumented +# sources; test-lorem-optimum-benchmark's wall-clock assertions fail when +# instrumentation slows execution). Excluded from `make coverage' only. COVERAGE_EXCLUDE = \ $(TEST_DIR)/test-all-comp-errors.el \ $(TEST_DIR)/test-lorem-optimum-benchmark.el -- cgit v1.2.3