Fixes command arguments doc #2048
Open
Conversation
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
✅ Deploy Preview for redis-doc ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
guybe7
reviewed
Jul 21, 2022
| @@ -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.
unless it's a "container" argument (not sure about the name) - i.e. "oneof" or "block"
There was a problem hiding this comment.
For arguments types other than _oneof_ and _block_, this is a string that describes the value in the command's syntax.
(from below)
nermiller
reviewed
Nov 10, 2022
| @@ -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.
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. |
|
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.