Merge pull request #11717 from llakala/patch-1

docs: clarify syntax for escaping dollar curlies
NixOS · Oct 21, 2024 · 1ed1663 · 1ed1663
2 parents 63e6672 + defff01
commit 1ed1663
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/doc/manual/source/language/string-literals.md b/doc/manual/source/language/string-literals.md
@@ -150,6 +150,21 @@ These special characters are escaped as follows:
 
 `''\` escapes any other character.
 
+A "dollar-curly" (`${`) can be written as follows: 
+> **Example**
+>
+> ```nix
+> ''
+>   echo ''${PATH}
+> ''
+> ```
+>
+>     "echo ${PATH}\n"
+
+> **Note**
+>
+> This differs from the syntax for escaping a dollar-curly within double quotes (`"\${"`). Be aware of which one is needed at a given moment.
+
 A "double-dollar-curly" (`$${`) can be written literally.
 
 > **Example**