Skip to content
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.

Sign up for GitHub

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

[Doc] Add note for examples. #260

Merged
merged 1 commit into from
Jun 14, 2023
Merged

[Doc] Add note for examples. #260

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/pages/usage/workspace_editor.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -362,6 +362,10 @@ In the `EXAMPLE` section, you can add examples for the commands.

![add_command_examples](../../assets/recordings/workspace_editor/add_command_examples.gif)

> **Note**
>
> Please use [shorthand syntax](https://github.com/Azure/azure-cli/blob/dev/doc/shorthand_syntax.md) for complicated argument values, so that the examples can be run in **Powershell**, **Windows Command Prompt** and **Bash** without [escaping rules](https://learn.microsoft.com/en-us/cli/azure/use-cli-effectively?tabs=bash%2Cbash2#use-quotation-marks-in-parameters).

## Reload from swagger

When developing commands, it may be necessary to correct Swagger errors. You can use the `↻` button to reload swagger resources on demand. aaz-dev tool can apply the change in swagger and inherit previous modifications in workspace intelligently.
Expand Down