-
Notifications
You must be signed in to change notification settings - Fork 3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix examples and documentation to correctly escape or quote shell cha… #5066
Conversation
View a preview at https://prompt.ws/r/Azure/azure-cli/5066 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see some examples like ${this} and others like {$this}. Are we intending this to be bash-specific variable notation, or is this more of a doc markup issue?
@tjprescott This is probably a |
@sptramer thanks. Before we had discussed avoiding shell-specific nomenclature or at the very least calling it out. This would make many examples that would work in bash or CMD now bash-specific. I'm not necessarily against that--I just want that to be a deliberate decision. I agree with the CAP_SNAKE vs. CamelCase. |
@tjprescott I believe that we have standardized on the idea that examples and inline code presented in documentation is meant to be |
I'm okay with the bash specific if Jason is. But I would like use to resolve the ${foo} or {$foo} references in the PR :) |
@tjprescott On it and it should be fixed by EOB today. |
@tjprescott - Went ahead and fixed things. Right now I'm leaving off the |
@tjprescott CI is failing due to not having version-bumped the command modules, but in the past we have agreed that |
Due to recent changes to the CLI core, you will need to rebase your changes against the latest in the dev branch. |
@tjprescott Rebased and updated. |
@derekbekoe can the version check script be updated to ignore modules whose only changes are to |
Can you rebase the latest dev changes? Should fix the issue with role version. |
…racters where required. [#4876]
Simplify user-supplied values by marking them as ${...} variables.
This checklist is used to make sure that common guidelines for a pull request are followed.
General Guidelines
Command Guidelines
(see Authoring Command Modules)