From e5974b316d83540eb79d716ac2ee8c8e35fd61b2 Mon Sep 17 00:00:00 2001
From: Matt Sturgeon <matt@sturgeon.me.uk>
Date: Fri, 27 Dec 2024 20:17:39 +0000
Subject: [PATCH] modules/test: document possible types for expectation `value`

---
 modules/top-level/test.nix | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/modules/top-level/test.nix b/modules/top-level/test.nix
index 938aa07f..ef27d609 100644
--- a/modules/top-level/test.nix
+++ b/modules/top-level/test.nix
@@ -43,7 +43,14 @@ let
             if config.expect == null then
               lib.types.unspecified
               // {
-                description = "defined by `expect`";
+                description = ''
+                  Depends on `expect`:
+                  ${lib.concatStringsSep "\n" (
+                    lib.mapAttrsToList (
+                      name: spec: "- ${builtins.toJSON name}: ${spec.valueType.description}"
+                    ) cfg.namedExpectationPredicates
+                  )}
+                '';
               }
             else
               namedPredicate.valueType;