Fix examples and documentation to correctly escape or quote shell cha… (

#5066) * Fix examples and documentation to correctly escape or quote shell characters where required. [#4876] Simplify user-supplied values by marking them as ${...} variables. * Fix examples and documentation to correctly escape or quote shell characters where required. [#4876] * Version bumps for publishing * More version bumps. * Fix duplicate history version.
Azure · Jan 11, 2018 · d93f0af · d93f0af
1 parent a20d1c6
commit d93f0af
Show file tree

Hide file tree

Showing 23 changed files with 256 additions and 233 deletions.
diff --git a/src/command_modules/azure-cli-appservice/azure/cli/command_modules/appservice/_help.py b/src/command_modules/azure-cli-appservice/azure/cli/command_modules/appservice/_help.py
@@ -506,7 +506,7 @@
     examples:
         - name: List default host name and state for all web apps.
           text: >
-            az webapp list --query "[].{ hostName: defaultHostName, state: state }"
+            az webapp list --query "[].{hostName: defaultHostName, state: state}"
         - name: List all running web apps.
           text: >
             az webapp list --query "[?state=='Running']"
@@ -558,7 +558,7 @@
     examples:
         - name: List default host name and state for all function apps.
           text: >
-            az functionapp list --query "[].{ hostName: defaultHostName, state: state }"
+            az functionapp list --query "[].{hostName: defaultHostName, state: state}"
         - name: List all running function apps.
           text: >
             az functionapp list --query "[?state=='Running']"

diff --git a/src/command_modules/azure-cli-dla/HISTORY.rst b/src/command_modules/azure-cli-dla/HISTORY.rst
@@ -3,6 +3,10 @@
 Release History
 ===============
 
+0.0.17
+++++++
+* Update helpfile
+
 0.0.16
 ++++++
 * Update for CLI core changes.

diff --git a/src/command_modules/azure-cli-dla/azure/cli/command_modules/dla/_help.py b/src/command_modules/azure-cli-dla/azure/cli/command_modules/dla/_help.py
@@ -25,7 +25,7 @@
           short-summary: Name for the submitted job.
         - name: --script
           type: string
-          short-summary: Script to submit. This may be an @{file} to load from a file.
+          short-summary: Script to submit. This may be '@{file}' to load from a file.
         - name: --runtime-version
           short-summary: The runtime version to use.
           long-summary: This parameter is used for explicitly overwriting the default runtime. It should only be done if you know what you are doing.

diff --git a/src/command_modules/azure-cli-dla/setup.py b/src/command_modules/azure-cli-dla/setup.py
@@ -16,7 +16,7 @@
     cmdclass = {}
 
 
-VERSION = "0.0.16"
+VERSION = "0.0.17"
 # The full list of classifiers is available at
 # https://pypi.python.org/pypi?%3Aaction=list_classifiers
 CLASSIFIERS = [

diff --git a/src/command_modules/azure-cli-lab/HISTORY.rst b/src/command_modules/azure-cli-lab/HISTORY.rst
@@ -3,6 +3,10 @@
 Release History
 ===============
 
+0.0.15
+++++++
+* Update helpfile
+
 0.0.14
 ++++++
 * Update for CLI core changes.

diff --git a/src/command_modules/azure-cli-lab/azure/cli/command_modules/lab/_help.py b/src/command_modules/azure-cli-lab/azure/cli/command_modules/lab/_help.py
@@ -55,10 +55,10 @@
                   short-summary: 'Type of IP configuration to use for the VM. Allowed values are: shared, public, private.'
                   long-summary: If omitted, will be selected based on the VM's vnet.
                 - name: --artifacts
-                  short-summary: JSON encoded array of artifacts to be applied. Use @{file} to load from a file.
+                  short-summary: JSON encoded array of artifacts to be applied. Use '@{file}' to load from a file.
                 - name: --tags
                   short-summary: Space separated tags in `key[=value]` format.
-                  long-summary: Tags may be cleared by assigning the empty value `""` to them.
+                  long-summary: Tags may be cleared by assigning the empty value "" to them.
                 - name: --allow-claim
                   short-summary: Flag indicating if the VM should be created as claimable.
                 - name: --disk-type
@@ -70,25 +70,25 @@
             examples:
                 - name: Create a VM in the lab from a gallery image.
                   text: >
-                    az lab vm create --lab-name MyLab -g MyRG --name MyVM --image "Ubuntu Server 16.04 LTS" --image-type gallery --size Standard_DS1_v2
+                    az lab vm create --lab-name {LabName} -g {ResourceGroup} --name {VMName} --image "Ubuntu Server 16.04 LTS" --image-type gallery --size Standard_DS1_v2
                 - name: Create a VM in the lab from a gallery image with SSH authentication.
                   text: >
-                    az lab vm create --lab-name MyLab -g MyRG --name MyVM --image "Ubuntu Server 16.04 LTS" --image-type gallery --size Standard_DS1_v2 --authentication-type ssh
+                    az lab vm create --lab-name {LabName} -g {ResourceGroup} --name {VMName} --image "Ubuntu Server 16.04 LTS" --image-type gallery --size Standard_DS1_v2 --authentication-type ssh
                 - name: Create a claimable VM in the lab from a gallery image with password authentication.
                   text: >
-                    az lab vm create --lab-name MyLab -g MyRG --name MyVM --image "Ubuntu Server 16.04 LTS" --image-type gallery --size Standard_DS1_v2 --allow-claim
+                    az lab vm create --lab-name {LabName} -g {ResourceGroup} --name {VMName} --image "Ubuntu Server 16.04 LTS" --image-type gallery --size Standard_DS1_v2 --allow-claim
                 - name: Create a windows VM in the lab from a gallery image with password authentication.
                   text: >
-                    az lab vm create --lab-name MyLab -g MyRG --name MyVM --image "Windows Server 2008 R2 SP1" --image-type gallery --size Standard_DS1_v2
+                    az lab vm create --lab-name {LabName} -g {ResourceGroup} --name {VMName} --image "Windows Server 2008 R2 SP1" --image-type gallery --size Standard_DS1_v2
                 - name: Create a VM in the lab from a custom image.
                   text: >
-                    az lab vm create --lab-name MyLab -g MyRG --name MyVM --image "jenkins_custom" --image-type custom --size Standard_DS1_v2
+                    az lab vm create --lab-name {LabName} -g {ResourceGroup} --name {VMName} --image "jenkins_custom" --image-type custom --size Standard_DS1_v2
                 - name: Create a VM in the lab with a public IP.
                   text: >
-                    az lab vm create --lab-name MyLab -g MyRG --name MyVM --image "Ubuntu Server 16.04 LTS" --image-type gallery --size Standard_DS1_v2 --ip-configuration public
+                    az lab vm create --lab-name {LabName} -g {ResourceGroup} --name {VMName} --image "Ubuntu Server 16.04 LTS" --image-type gallery --size Standard_DS1_v2 --ip-configuration public
                 - name: Create a VM from a formula.
                   text: >
-                    az lab vm create --lab-name MyLab -g MyRG --name MyVM --formula MyFormula --artifacts @/artifacts.json
+                    az lab vm create --lab-name {LabName} -g {ResourceGroup} --name {VMName} --formula MyFormula --artifacts '@artifacts.json'
             """
 helps['lab vm list'] = """
             type: command
@@ -124,7 +124,7 @@
                 - name: --name -n
                   short-summary: Name of the virtual machine.
                 - name: --artifacts
-                  short-summary: JSON encoded array of artifacts to be applied. Use @{file} to load from a file.
+                  short-summary: JSON encoded array of artifacts to be applied. Use '@{file}' to load from a file.
             """
 helps['lab vm claim'] = """
             type: command
@@ -141,15 +141,15 @@
             examples:
                 - name: Claim any available virtual machine in the lab.
                   text: >
-                    az lab vm claim -g MyRG --lab-name MyLab
+                    az lab vm claim -g {ResourceGroup} --lab-name {LabName}
                 - name: Claim a specific virtual machine in the lab.
                   text: >
-                    az lab vm claim -g MyRG --lab-name MyLab --name MyVM
-                - name: Claim multiple virtual machines in the lab using `--ids`.
+                    az lab vm claim -g {ResourceGroup} --lab-name {LabName} --name {VMName}
+                - name: Claim multiple virtual machines in the lab by IDs.
                   text: |
                     az lab vm claim --ids \\
-                        /subscriptions/{SubID}/resourcegroups/{MyRG}/providers/microsoft.devtestlab/labs/{MyLab}/virtualmachines/{MyVM1} \\
-                        /subscriptions/{SubID}/resourcegroups/{MyRG}/providers/microsoft.devtestlab/labs/{MyLab}/virtualmachines/{MyVM2}
+                        /subscriptions/{SubID}/resourcegroups/{ResourceGroup}/providers/microsoft.devtestlab/labs/{LabName}/virtualmachines/{VMName1} \\
+                        /subscriptions/{SubID}/resourcegroups/{ResourceGroup}/providers/microsoft.devtestlab/labs/{LabName}/virtualmachines/{VMName2}
             """
 helps['lab custom-image'] = """
             type: group
@@ -175,13 +175,13 @@
                   short-summary: The current state of the virtual machine.
                   long-summary: >
                     For Windows virtual machines: NonSysprepped, SysprepRequested, SysprepApplied
-                    For Linux virtual machines - NonDeprovisioned, DeprovisionRequested, DeprovisionApplied
+                    For Linux virtual machines: NonDeprovisioned, DeprovisionRequested, DeprovisionApplied
             examples:
                 - name: Create a custom image in the lab from a running Windows virtual machine without applying sysprep.
                   text: |
-                    az lab custom-image create --lab-name MyLab -g MyRG --name MyVM \\
+                    az lab custom-image create --lab-name {LabName} -g {ResourceGroup} --name {VMName} \\
                         --os-type Windows --os-state NonSysprepped \\
-                        --source-vm-id "/subscriptions/{SubID}/resourcegroups/{MyRG}/microsoft.devtestlab/labs/{MyLab}/virtualmachines/{MyVM}"
+                        --source-vm-id "/subscriptions/{SubID}/resourcegroups/{ResourceGroup}/microsoft.devtestlab/labs/{LabName}/virtualmachines/{VMName}"
 """
 helps['lab gallery-image'] = """
             type: group
@@ -276,7 +276,7 @@
                   populator-commands:
                     - az lab artifact-source list
                 - name: --parameters
-                  short-summary: JSON encoded list of parameters. Use @{file} to load from a file.
+                  short-summary: JSON encoded list of parameters. Use '@{file}' to load from a file.
                 - name: --tags
                   short-summary: The tags for the resource.
             """

diff --git a/src/command_modules/azure-cli-lab/setup.py b/src/command_modules/azure-cli-lab/setup.py
@@ -12,7 +12,7 @@
     logger.warn("Wheel is not available, disabling bdist_wheel hook")
     cmdclass = {}
 
-VERSION = "0.0.14"
+VERSION = "0.0.15"
 CLASSIFIERS = [
     'Development Status :: 4 - Beta',
     'Intended Audience :: Developers',