futriix/src/commands/zremrangebyrank.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

56 lines
1.5 KiB
JSON

{
"ZREMRANGEBYRANK": {
"summary": "Removes members in a sorted set within a range of indexes. Deletes the sorted set if all members were removed.",
"complexity": "O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements removed by the operation.",
"group": "sorted_set",
"since": "2.0.0",
"arity": 4,
"function": "zremrangebyrankCommand",
"command_flags": [
"WRITE"
],
"acl_categories": [
"SORTEDSET"
],
"key_specs": [
{
"flags": [
"RW",
"DELETE"
],
"begin_search": {
"index": {
"pos": 1
}
},
"find_keys": {
"range": {
"lastkey": 0,
"step": 1,
"limit": 0
}
}
}
],
"reply_schema": {
"type": "integer",
"description": "Number of elements removed."
},
"arguments": [
{
"name": "key",
"type": "key",
"key_spec_index": 0
},
{
"name": "start",
"type": "integer"
},
{
"name": "stop",
"type": "integer"
}
]
}
}