diff options
| author | Dean Troyer <dtroyer@gmail.com> | 2014-12-31 10:05:37 -0600 |
|---|---|---|
| committer | Dean Troyer <dtroyer@gmail.com> | 2014-12-31 10:07:14 -0600 |
| commit | b5ce0f145f9342a01370ac34a7a11d40df703249 (patch) | |
| tree | fd64a560378c6e9a29e6160f7074160c862e038b /doc/source/command-objects | |
| parent | be8cac9cea15e4935247df5e41a3cfdc7a58e204 (diff) | |
| download | python-openstackclient-b5ce0f145f9342a01370ac34a7a11d40df703249.tar.gz | |
Command docs: region
Fix up formatting fro region command docs and help
Change-Id: Icf8c03da38b30fc69e7fe70f9c14aaa99881d320
Diffstat (limited to 'doc/source/command-objects')
| -rw-r--r-- | doc/source/command-objects/region.rst | 68 |
1 files changed, 44 insertions, 24 deletions
diff --git a/doc/source/command-objects/region.rst b/doc/source/command-objects/region.rst index 788ed6fa..d1aedb31 100644 --- a/doc/source/command-objects/region.rst +++ b/doc/source/command-objects/region.rst @@ -9,24 +9,30 @@ region create Create new region +.. program:: region create .. code:: bash os region create [--parent-region <region-id>] - [--description <region-description>] - [--url <region-url>] + [--description <description>] + [--url <url>] <region-id> -:option:`--parent-region` <region-id> - Parent region +.. option:: --parent-region <region-id> + + Parent region ID + +.. option:: --description <description> -:option:`--description` <region-description> New region description -:option:`--url` <region-url> +.. option:: --url <url> + New region URL -:option:`<region-id>` +.. _region_create-region-id: +.. describe:: <region-id> + New region ID region delete @@ -34,61 +40,75 @@ region delete Delete region +.. program:: region delete .. code:: bash os region delete - <region> + <region-id> + +.. _region_delete-region-id: +.. describe:: <region-id> -:option:`<region>` - Region to delete + Region ID to delete region list ----------- List regions +.. program:: region list .. code:: bash os region list [--parent-region <region-id>] -:option:`--parent-region` <region-id> - Filter by a specific parent region +.. option:: --parent-region <region-id> + + Filter by parent region ID region set ---------- Set region properties +.. program:: region set .. code:: bash os region set [--parent-region <region-id>] - [--description <region-description>] - [--url <region-url>] - <region> + [--description <description>] + [--url <url>] + <region-id> -:option:`--parent-region` <region-id> - New parent region +.. option:: --parent-region <region-id> + + New parent region ID + +.. option:: --description <description> -:option:`--description` <region-description> New region description -:option:`--url` <region-url> +.. option:: --url <url> + New region URL -:option:`<region>` +.. _region_set-region-id: +.. describe:: <region-id> + Region ID to modify region show ----------- -Show region +Display region details +.. program:: region show .. code:: bash os region show - <region> + <region-id> -:option:`<region>` - Region ID to modify +.. _region_show-region-id: +.. describe:: <region-id> + + Region ID to display |