Merge pull request #121587 from hercules-ci/nixos-test-inline-doc

testing-python.nix: document runTests pos argument

1 files changed, 7 insertions, 2 deletions

diff --git a/nixos/lib/testing-python.nix b/nixos/lib/testing-python.nix
index cbe90ff4cbf..6497b897eaf 100644
--- a/nixos/lib/testing-python.nix
+++ b/nixos/lib/testing-python.nix
@@ -54,8 +54,13 @@ rec {
     };
 
   # Run an automated test suite in the given virtual network.
-  # `driver' is the script that runs the network.
-  runTests = { driver, pos }:
+  runTests = {
+    # the script that runs the network
+    driver,
+    # a source position in the format of builtins.unsafeGetAttrPos
+    # for meta.position
+    pos,
+  }:
     stdenv.mkDerivation {
       name = "vm-test-run-${driver.testName}";