Unverified Commit 0c3b8b7e authored by Itamar Haber's avatar Itamar Haber Committed by GitHub
Browse files

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.
parent cb171786
{ {
"LOAD": { "LOAD": {
"summary": "Load a module", "summary": "Loads a module.",
"complexity": "O(1)", "complexity": "O(1)",
"group": "server", "group": "server",
"since": "4.0.0", "since": "4.0.0",
......
{ {
"LOADEX": { "LOADEX": {
"summary": "Load a module with extended parameters", "summary": "Loads a module using extended parameters.",
"complexity": "O(1)", "complexity": "O(1)",
"group": "server", "group": "server",
"since": "7.0.0", "since": "7.0.0",
......
{ {
"UNLOAD": { "UNLOAD": {
"summary": "Unload a module", "summary": "Unloads a module.",
"complexity": "O(1)", "complexity": "O(1)",
"group": "server", "group": "server",
"since": "4.0.0", "since": "4.0.0",
......
{ {
"MODULE": { "MODULE": {
"summary": "A container for module commands", "summary": "A container for module commands.",
"complexity": "Depends on subcommand.", "complexity": "Depends on subcommand.",
"group": "server", "group": "server",
"since": "4.0.0", "since": "4.0.0",
......
{ {
"MONITOR": { "MONITOR": {
"summary": "Listen for all requests received by the server in real time", "summary": "Listens for all requests received by the server in real-time.",
"group": "server", "group": "server",
"since": "1.0.0", "since": "1.0.0",
"arity": 1, "arity": 1,
......
{ {
"MOVE": { "MOVE": {
"summary": "Move a key to another database", "summary": "Moves a key to another database.",
"complexity": "O(1)", "complexity": "O(1)",
"group": "generic", "group": "generic",
"since": "1.0.0", "since": "1.0.0",
......
{ {
"MSET": { "MSET": {
"summary": "Set multiple keys to multiple values", "summary": "Atomically creates or modifies the string values of one or more keys.",
"complexity": "O(N) where N is the number of keys to set.", "complexity": "O(N) where N is the number of keys to set.",
"group": "string", "group": "string",
"since": "1.0.1", "since": "1.0.1",
......
{ {
"MSETNX": { "MSETNX": {
"summary": "Set multiple keys to multiple values, only if none of the keys exist", "summary": "Atomically modifies the string values of one or more keys only when all keys don't exist.",
"complexity": "O(N) where N is the number of keys to set.", "complexity": "O(N) where N is the number of keys to set.",
"group": "string", "group": "string",
"since": "1.0.1", "since": "1.0.1",
......
{ {
"MULTI": { "MULTI": {
"summary": "Mark the start of a transaction block", "summary": "Starts a transaction.",
"complexity": "O(1)", "complexity": "O(1)",
"group": "transactions", "group": "transactions",
"since": "1.2.0", "since": "1.2.0",
......
{ {
"ENCODING": { "ENCODING": {
"summary": "Inspect the internal encoding of a Redis object", "summary": "Returns the internal encoding of a Redis object.",
"complexity": "O(1)", "complexity": "O(1)",
"group": "generic", "group": "generic",
"since": "2.2.3", "since": "2.2.3",
......
{ {
"FREQ": { "FREQ": {
"summary": "Get the logarithmic access frequency counter of a Redis object", "summary": "Returns the logarithmic access frequency counter of a Redis object.",
"complexity": "O(1)", "complexity": "O(1)",
"group": "generic", "group": "generic",
"since": "4.0.0", "since": "4.0.0",
......
{ {
"HELP": { "HELP": {
"summary": "Show helpful text about the different subcommands", "summary": "Returns helpful text about the different subcommands.",
"complexity": "O(1)", "complexity": "O(1)",
"group": "generic", "group": "generic",
"since": "6.2.0", "since": "6.2.0",
......
{ {
"IDLETIME": { "IDLETIME": {
"summary": "Get the time since a Redis object was last accessed", "summary": "Returns the time since the last access to a Redis object.",
"complexity": "O(1)", "complexity": "O(1)",
"group": "generic", "group": "generic",
"since": "2.2.3", "since": "2.2.3",
......
{ {
"REFCOUNT": { "REFCOUNT": {
"summary": "Get the number of references to the value of the key", "summary": "Returns the reference count of a value of a key.",
"complexity": "O(1)", "complexity": "O(1)",
"group": "generic", "group": "generic",
"since": "2.2.3", "since": "2.2.3",
......
{ {
"OBJECT": { "OBJECT": {
"summary": "A container for object introspection commands", "summary": "A container for object introspection commands.",
"complexity": "Depends on subcommand.", "complexity": "Depends on subcommand.",
"group": "generic", "group": "generic",
"since": "2.2.3", "since": "2.2.3",
......
{ {
"PERSIST": { "PERSIST": {
"summary": "Remove the expiration from a key", "summary": "Removes the expiration time of a key.",
"complexity": "O(1)", "complexity": "O(1)",
"group": "generic", "group": "generic",
"since": "2.2.0", "since": "2.2.0",
......
{ {
"PEXPIRE": { "PEXPIRE": {
"summary": "Set a key's time to live in milliseconds", "summary": "Sets the expiration time of a key in milliseconds.",
"complexity": "O(1)", "complexity": "O(1)",
"group": "generic", "group": "generic",
"since": "2.6.0", "since": "2.6.0",
......
{ {
"PEXPIREAT": { "PEXPIREAT": {
"summary": "Set the expiration for a key as a UNIX timestamp specified in milliseconds", "summary": "Sets the expiration time of a key to a Unix milliseconds timestamp.",
"complexity": "O(1)", "complexity": "O(1)",
"group": "generic", "group": "generic",
"since": "2.6.0", "since": "2.6.0",
......
{ {
"PEXPIRETIME": { "PEXPIRETIME": {
"summary": "Get the expiration Unix timestamp for a key in milliseconds", "summary": "Returns the expiration time of a key as a Unix milliseconds timestamp.",
"complexity": "O(1)", "complexity": "O(1)",
"group": "generic", "group": "generic",
"since": "7.0.0", "since": "7.0.0",
......
{ {
"PFADD": { "PFADD": {
"summary": "Adds the specified elements to the specified HyperLogLog.", "summary": "Adds elements to a HyperLogLog key. Creates the key if it doesn't exist.",
"complexity": "O(1) to add every element.", "complexity": "O(1) to add every element.",
"group": "hyperloglog", "group": "hyperloglog",
"since": "2.8.9", "since": "2.8.9",
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment