From b145a2882afcdebb30b07c5883546aad79e4e46c Mon Sep 17 00:00:00 2001
From: Sridhar Ratnakumar <srid@srid.ca>
Date: Wed, 14 Feb 2024 06:09:37 -0500
Subject: [PATCH] fully document the key

---
 nixos/easy-github-runners.nix | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/nixos/easy-github-runners.nix b/nixos/easy-github-runners.nix
index 20847b3..7da084d 100644
--- a/nixos/easy-github-runners.nix
+++ b/nixos/easy-github-runners.nix
@@ -23,7 +23,10 @@ in
       description = ''
         Attrset of runners.
 
-        The key is either org name or the repo path.
+        The key will be used to identify the runner name. It could be either org
+        name or the repo path, unless you want to run multiple runners per
+        org/repo, in which case choose a suitably unique key while setting org
+        name or repo path in `githubPath` option.
       '';
       type = types.lazyAttrsOf (types.submodule ({ config, name, ... }: {
         options = {