0c3b8b7e90
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.
29 lines
866 B
JSON
29 lines
866 B
JSON
{
|
|
"NUMSUB": {
|
|
"summary": "Returns a count of subscribers to channels.",
|
|
"complexity": "O(N) for the NUMSUB subcommand, where N is the number of requested channels",
|
|
"group": "pubsub",
|
|
"since": "2.8.0",
|
|
"arity": -2,
|
|
"container": "PUBSUB",
|
|
"function": "pubsubCommand",
|
|
"command_flags": [
|
|
"PUBSUB",
|
|
"LOADING",
|
|
"STALE"
|
|
],
|
|
"arguments": [
|
|
{
|
|
"name": "channel",
|
|
"type": "string",
|
|
"optional": true,
|
|
"multiple": true
|
|
}
|
|
],
|
|
"reply_schema": {
|
|
"description": "the number of subscribers per channel, each even element (including 0th) is channel name, each odd element is the number of subscribers",
|
|
"type": "array"
|
|
}
|
|
}
|
|
}
|