clarify env.value

viperML · Jun 10, 2024 · 307eb5c · 307eb5c
1 parent 1ba792f
commit 307eb5c
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/modules/env-type.nix b/modules/env-type.nix
@@ -24,6 +24,9 @@ in {
       description = mdDoc ''
         Value of the variable to be set.
         Set to `null` to unset the variable.
+
+        Note that any environment variable will be escaped. For example, `value = "$HOME"`
+        will be converted to the literal `$HOME`, with its dollar sign.
       '';
     };