You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
For clarity, I suggest that fixed tokens are capitalized in command syntax. This makes all fixed content of a command syntax render as capitalized (command name and tokens) and variable content as lowercase (key names, values, etc.).
For example, the type tokens of CLIENT LIST.
Current rendering:
CLIENT LIST [ TYPE normal | master | replica | pubsub ] [ ID client-id ] [ [ ID client-id ] ... ]
Expected rendering of the TYPE argument (with normal, master, replica, pubsub capitalized):
[ TYPE <NORMAL | MASTER | REPLICA | PUBSUB> ]
Bonus: In this example, it would help to display the < and > around the arguments after the TYPE token, to disambiguate the syntax. Otherwise, [ TYPE NORMAL | MASTER | REPLICA | PUBSUB ] can be interpreted as TYPE NORMAL or MASTER or REPLICA or PUBSUB, i.e. as if the word "TYPE" is only included in TYPE NORMAL but not in the others.
(This is how it's rendered on Redis website and our man pages btw.)
Details
The TYPE argument in CLIENT LIST has the JSON definition below.
Not that it is "optional" ([...] around the whole arguemnt) and has type "oneof" (<...> around the things that follow after TYPE).
In the command page's "Usage:", the lower case `name` was used in case
of a `pure-token`. However, the all caps `token` should be used instead.
For MIGRATE, this makes an even bigger difference (see `empty-string`):
Before:
```
Usage:
MIGRATE host port 〈 key | empty-string 〉 destination-db timeout [ copy ] [ replace ] [ AUTH auth | AUTH2 username password ] [ KEYS keys ] [ [ KEYS keys ] ... ]
```
Now:
```
Usage:
MIGRATE host port 〈 key | "" 〉 destination-db timeout [ COPY ] [ REPLACE ] [ AUTH auth | AUTH2 username password ] [ KEYS keys ] [ [ KEYS keys ] ... ]
```
This addresses a part of #116
By submitting this pull request, I confirm that my contribution is made
under the terms of the BSD-3-Clause License.
Signed-off-by: Simon Baatz <[email protected]>
For clarity, I suggest that fixed tokens are capitalized in command syntax. This makes all fixed content of a command syntax render as capitalized (command name and tokens) and variable content as lowercase (key names, values, etc.).
For example, the type tokens of CLIENT LIST.
Current rendering:
Expected rendering of the
TYPE
argument (with normal, master, replica, pubsub capitalized):Bonus: In this example, it would help to display the
<
and>
around the arguments after theTYPE
token, to disambiguate the syntax. Otherwise,[ TYPE NORMAL | MASTER | REPLICA | PUBSUB ]
can be interpreted asTYPE NORMAL
orMASTER
orREPLICA
orPUBSUB
, i.e. as if the word "TYPE" is only included inTYPE NORMAL
but not in the others.(This is how it's rendered on Redis website and our man pages btw.)
Details
The TYPE argument in CLIENT LIST has the JSON definition below.
Not that it is "optional" (
[...]
around the whole arguemnt) and has type "oneof" (<...>
around the things that follow afterTYPE
).The text was updated successfully, but these errors were encountered: