-
Notifications
You must be signed in to change notification settings - Fork 1.7k
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.
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
Fixes command arguments doc #2048
Open
itamarhaber
wants to merge
1
commit into
redis:master
Choose a base branch
from
itamarhaber:fix-command-arguments
base: master
Could not load branches
Branch not found: {{ refName }}
Could not load tags
Nothing to show
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||||
---|---|---|---|---|---|---|---|---|
|
@@ -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. | ||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||
* **type:** the argument's type, always present. | ||||||||
An argument must have one of the following types: | ||||||||
- **string:** a string argument. | ||||||||
|
@@ -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 | ||||||||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(from below)