cli: describe how to set a config value with apostrophes #5619
+12
−3
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
martinvonz
force-pushed
the
push-pyvkyyytuqrm
branch
2 times, most recently
from
f5fb73c to
adc2af4
Compare
yuja
approved these changes
Feb 8, 2025
cli/src/commands/config/set.rs
Outdated
| /// notation), quotes can be omitted. Note that the value may also need | ||
| /// shell quoting. The exact syntax depends on your shell. For example, | ||
| /// to set `foo.bar` to the string "don't" in Bash, use | ||
| /// `jj config set --user foo.bar '"don'\''t"'`. In Fish, use |
There was a problem hiding this comment.
nit: triple quotes can be used in order to avoid closing/reopening shell quotes:
"'''don't'''"
There was a problem hiding this comment.
That produces a different result in the TOML source. I don't like to give different examples for Bash and Fish that produce different results even if they represent the same string in the end. We could use the TOML triple quotes for both shells. Do you prefer that?
There was a problem hiding this comment.
Yes, I would rewrite both. The bash example is hard to parse without further explanation.
There was a problem hiding this comment.
I've updated it to use the multi-line syntax and reworded a bit. PTAL
Apostrophes are not uncommon in e.g. `user.name`, so let's help the user by providing examples.
martinvonz
force-pushed
the
push-pyvkyyytuqrm
branch
from
adc2af4 to
511f911
Compare
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.
Checklist
If applicable:
CHANGELOG.md