diff options
| author |   Rich Bennett <rb2745@att.com> | 2017-10-13 15:28:09 -0400 |
|---|---|---|
| committer | Rich Bennett <rb2745@att.com> | 2017-10-13 15:32:13 -0400 |
| commit | dd0f4438e8dea6ef68a043488545e3efcb3fa78a (patch) | |
| tree | ced34525665cc8c4b35a79c0ee7a50290c60240c /docs/open_cli_schema_version_1_0.rst | |
| parent | 0e89c1fbeb6618a1a4218c7c78506dff6f71dd6d (diff) | |
Minor edits to resturcture text documentation
Improved cross references, bullet lists, and used code-block directive on bash cmds
Added release-notes template
Change-Id: Id12fb1b77ef9690b5b50505e47ec7035039f2f24
Issue-ID: CLI-54
Signed-off-by: Rich Bennett <rb2745@att.com>
Diffstat (limited to 'docs/open_cli_schema_version_1_0.rst')
| -rw-r--r-- | docs/open_cli_schema_version_1_0.rst | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/docs/open_cli_schema_version_1_0.rst b/docs/open_cli_schema_version_1_0.rst index 5d649eaf..c907172e 100644 --- a/docs/open_cli_schema_version_1_0.rst +++ b/docs/open_cli_schema_version_1_0.rst @@ -1,8 +1,9 @@ -.. _open_cli_schema_version_1_0: .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 .. Copyright 2017 Huawei Technologies Co., Ltd. +.. _open_cli_schema_version_1_0: + Open Command Line Interface (CLI) Schema Version (OCS) 1.0 ========================================================== @@ -638,11 +639,11 @@ direction printed. It can be: * *portrait* : To print the results in two columns. First column is the name of -the attribute and second column is the value of the attribute. It's more useful -while command does operations like creation of resource, viewing of resources. + the attribute and second column is the value of the attribute. It's more useful + while command does operations like creation of resource, viewing of resources. * *landscape* : To print the results row vise in landscape mode. It's more -useful while command does operations like listing of resource. + useful while command does operations like listing of resource. attributes ~~~~~~~~~~ @@ -691,8 +692,8 @@ there are two scopes: * *short* : attribute configured with this option will always printed by default * *long* : attriuted configured with this option will get printed only when -user inputs the default parameter *long*, defined in *default_parameters* -section. So to print all attributes of a command, user will input parameter: + user inputs the default parameter *long*, defined in *default_parameters* + section. So to print all attributes of a command, user will input parameter: --long |