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

Jump to bottom

Fixes command arguments doc #2048

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fixes command arguments doc #2048

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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 2 additions & 4 deletions docs/reference/command-arguments.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,7 @@ This key stores an array that describes the command's arguments.
Every element in the _arguments_ array is a map with the following fields:

* **name:** the argument's name, always present.
The name of an argument is given for identification purposes alone.
It isn't displayed during the command's syntax rendering.
The name is displayed during the command's syntax rendering as a placeholder for user input.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

unless it's a "container" argument (not sure about the name) - i.e. "oneof" or "block"

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

For arguments types other than _oneof_ and _block_, this is a string that describes the value in the command's syntax.

(from below)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The name is displayed during the command's syntax rendering as a placeholder for user input.
The name is displayed during the command's syntax rendering as a placeholder for user input.
For arguments types other than _oneof_ and _block_, this is a string that describes the value in the command's syntax.

* **type:** the argument's type, always present.
An argument must have one of the following types:
- **string:** a string argument.
Expand All @@ -41,8 +40,7 @@ Every element in the _arguments_ array is a map with the following fields:
- **optional**: denotes that the argument is optional (for example, the _GET_ clause of the `SET` command).
- **multiple**: denotes that the argument may be repeated (such as the _key_ argument of `DEL`).
- **multiple-token:** denotes the possible repetition of the argument with its preceding token (see `SORT`'s `GET pattern` clause).
* **value:** the argument's value.
For arguments types other than _oneof_ and _block_, this is a string that describes the value in the command's syntax.
* **arguments:** nested arguments.
For the _oneof_ and _block_ types, this is an array of nested arguments, each being a map as described in this section.

[tr]: /topics/key-specs
Expand Down