fully document the key

srid · Feb 14, 2024 · b145a28 · b145a28
1 parent c020151
commit b145a28
Showing 1 changed file with 4 additions and 1 deletion.
diff --git 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 = {