docs: clarify syntax for escaping dollar curlies #11717
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
3b388f6 added some wonderful information on escaping dollar curlies within a multiline string. This is specifically helpful for writing shell scripts within something like writeShellScriptBin / writeShellApplication.
However, this information was only added to the String Interpolation page of the manual. While it is useful there, the String Literals page also could do with a mention of it. The String Literals page already mentions escaping dollar curlies within a double-quoted string (
"\${"). Because the syntax for doing this within multiline strings differs, it should be mentioned on the same page. I think having this info in both locations is correct -- it's relevant for both sections.I'm sure some of my wording could be rephrased, and the markdown could be tweaked to make the example and note more readable. Feel free to nitpick small details.
Priorities and Process
Add 👍 to pull requests you find important.
The Nix maintainer team uses a GitHub project board to schedule and track reviews.