futriix/src/commands/lolwut.json
Itamar Haber 0c3b8b7e90
Overhauls command summaries and man pages. (#11942)
This is an attempt to normalize/formalize command summaries.

Main actions performed:

* Starts with the continuation of the phrase "The XXXX command, when called, ..." for user commands.
* Starts with "An internal command...", "A container command...", etc... when applicable.
* Always uses periods.
* Refrains from referring to other commands. If this is needed, backquotes should be used for command names.
* Tries to be very clear about the data type when applicable.
* Tries to mention additional effects, e.g. "The key is created if it doesn't exist" and "The set is deleted if the last member is removed."
* Prefers being terse over verbose.
* Tries to be consistent.
2023-03-29 20:48:59 +03:00

26 lines
662 B
JSON

{
"LOLWUT": {
"summary": "Displays computer art and the Redis version",
"group": "server",
"since": "5.0.0",
"arity": -1,
"function": "lolwutCommand",
"command_flags": [
"READONLY",
"FAST"
],
"reply_schema": {
"type": "string",
"description": "String containing the generative computer art, and a text with the Redis version."
},
"arguments": [
{
"token": "VERSION",
"name": "version",
"type": "integer",
"optional": true
}
]
}
}