Docs: add notes on command line quoting #1844
Conversation
|
I suspect |
facebook-github-bot
added
the
CLA Signed
| $ python my_app.py +foo="{a: 10}" # the string `+foo={a: 10}` is passed to Hydra by bash | ||
| foo: | ||
| a: 10 |
There was a problem hiding this comment.
I think this might be confusing. since we recommend quote key=value pare in single quote, maybe update this to
python my_app.py '+foo={a: 10}'
if we update the example like above, we can probably skip the comments
There was a problem hiding this comment.
Updated in d300016.
There was a problem hiding this comment.
Thanks @Jasha10 for updating the doc!
This is one of the most common questions we get - here is a list of tips from Omry (copy pasted from discussions before), could you also include them in the doc?
- quote the whole key=value pair with a single quote (this quote is for the benefit of the shell).
- do not quote keys.
- only quote values if they contain a space (it will work if you always quote values, but it will turn numbers into strings)
- when you are quoting values, use double quotes to avoid collision with the outer single quoted consumed by the shell.
Jasha10
changed the title
|
Rebased to incorporate recent CI fixes on the |
Updated in df625f8. |
| example above). | ||
| - When you are quoting values, use double quotes to avoid collision with the | ||
| outer single quoted consumed by the shell. | ||
|
|
There was a problem hiding this comment.
These are good basic rules that should cater for almost all cases.
BTW double quoting in the shell is more general than single quoting, as you can specify any character through the use of escapes (you can't have literal single quotes within single quoted args for example). But I wouldn't bother mentioning that in the doc as it's shell specific
This PR adds two notes to the documentation on command-line overrides.
Related to #1843.