fix: add documentation on substitution and shell variable expansion #38
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
Using double quotes for the REPLACEMENT argument with capture group
substitution in shells like Bash or zsh will not work as intended. For
example, a "${1}" will be replaced by the content of the shell variable 1
before rnr can read them, resulting in no substitution.
ismaelgv
requested changes
Nov 27, 2023
|
Thanks for the review! I've made the two changes. |
ismaelgv
reviewed
Nov 28, 2023
lucas-deangelis
force-pushed
the
shell-quoting-doc
branch
from
3141378
to
f84e7d7
Compare
ismaelgv
approved these changes
Nov 28, 2023
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.
As discussed in #37. I've kept the explanation in
.help()short to avoid either weird formatting or having to switch it to.long_help().Using double quotes for the REPLACEMENT argument with capture group substitution in shells like Bash or zsh will not work as intended. For example, a "${1}" will be replaced by the content of the shell variable 1 before rnr can read them, resulting in no substitution.