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. --- modules/lorem-optimum.el | 2 ++ 1 file changed, 2 insertions(+) (limited to 'modules') diff --git a/modules/lorem-optimum.el b/modules/lorem-optimum.el index 7b19125e..a6bec657 100644 --- a/modules/lorem-optimum.el +++ b/modules/lorem-optimum.el @@ -142,6 +142,8 @@ Uses O(n) algorithm by matching at position instead of creating substrings." (cj/markov-random-key chain))) (w1 (car state)) (w2 (cadr state)) + ;; tokens is built with `push' (prepend) and `nreverse'd at the end, + ;; so seed it reversed -- w2 then w1 -- to get w1 w2 ... after the flip. (tokens (list w2 w1))) (dotimes (_ (max 0 (- n 2))) (let ((next (cj/markov-next-word chain state))) -- cgit v1.2.3