diff options
| author | Dean Troyer <dtroyer@gmail.com> | 2017-04-03 16:15:14 -0500 |
|---|---|---|
| committer | Steve Martinelli <s.martinelli@gmail.com> | 2017-04-04 03:56:19 +0000 |
| commit | 1686dc54f09b6e77b1de3abc708c297710987a04 (patch) | |
| tree | 6c02758c2006da60f634940324c607e6785b433f /doc/source/command-objects/object.rst | |
| parent | b2ceb58fc377cd9030becaa934fc4e5d13cb55b4 (diff) | |
| download | python-openstackclient-1686dc54f09b6e77b1de3abc708c297710987a04.tar.gz | |
Help/docs cleanups: marker, limit, ip-address metavars
Cleanup help strings and docs for clarity and to keep things consistent:
* --limit metavar should be <num-resource> to indicate what is being counted
* --marker metavar should be <resource> or <resource-id> to indicate the
type of value being specified
* <*-ip-address> metavars should be just <ip-address> as there is no difference
in format between fixed and floating IPs
* Move all occurances of '(name or ID)' to end of help text
Change-Id: I2c31746ed6ded3845244e03e57d809f8bc0e6b9d
Diffstat (limited to 'doc/source/command-objects/object.rst')
| -rw-r--r-- | doc/source/command-objects/object.rst | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/source/command-objects/object.rst b/doc/source/command-objects/object.rst index 0a32a827..6323c4ed 100644 --- a/doc/source/command-objects/object.rst +++ b/doc/source/command-objects/object.rst @@ -62,7 +62,7 @@ List objects [--delimiter <delimiter>] [--marker <marker>] [--end-marker <end-marker>] - [--limit <limit>] + [--limit <num-objects>] [--long] [--all] <container> @@ -83,7 +83,7 @@ List objects End anchor for paging -.. option:: --limit <limit> +.. option:: --limit <num-objects> Limit number of objects returned |