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

53 lines
1.2 KiB
JSON

{
"PFDEBUG": {
"summary": "Internal commands for debugging HyperLogLog values.",
"complexity": "N/A",
"group": "hyperloglog",
"since": "2.8.9",
"arity": 3,
"function": "pfdebugCommand",
"doc_flags": [
"SYSCMD"
],
"command_flags": [
"WRITE",
"DENYOOM",
"ADMIN"
],
"acl_categories": [
"HYPERLOGLOG"
],
"key_specs": [
{
"flags": [
"RW",
"ACCESS"
],
"begin_search": {
"index": {
"pos": 2
}
},
"find_keys": {
"range": {
"lastkey": 0,
"step": 1,
"limit": 0
}
}
}
],
"arguments": [
{
"name": "subcommand",
"type": "string"
},
{
"name": "key",
"type": "key",
"key_spec_index": 0
}
]
}
}