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
{ {
"COUNT": { "COUNT": {
"summary": "Get total number of Redis commands", "summary": "Returns a count of commands.",
"complexity": "O(1)", "complexity": "O(1)",
"group": "server", "group": "server",
"since": "2.8.13", "since": "2.8.13",
......
{ {
"DOCS": { "DOCS": {
"summary": "Get array of specific Redis command documentation", "summary": "Returns documentary information about a command.",
"complexity": "O(N) where N is the number of commands to look up", "complexity": "O(N) where N is the number of commands to look up",
"group": "server", "group": "server",
"since": "7.0.0", "since": "7.0.0",
......
{ {
"GETKEYS": { "GETKEYS": {
"summary": "Extract keys given a full Redis command", "summary": "Extracts the key names from an arbitrary command.",
"complexity": "O(N) where N is the number of arguments to the command", "complexity": "O(N) where N is the number of arguments to the command",
"group": "server", "group": "server",
"since": "2.8.13", "since": "2.8.13",
......
{ {
"GETKEYSANDFLAGS": { "GETKEYSANDFLAGS": {
"summary": "Extract keys and access flags given a full Redis command", "summary": "Extracts the key names and access flags for an arbitrary command.",
"complexity": "O(N) where N is the number of arguments to the command", "complexity": "O(N) where N is the number of arguments to the command",
"group": "server", "group": "server",
"since": "7.0.0", "since": "7.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": "server", "group": "server",
"since": "5.0.0", "since": "5.0.0",
......
{ {
"INFO": { "INFO": {
"summary": "Get array of specific Redis command details, or all when no argument is given.", "summary": "Returns information about one, multiple or all commands.",
"complexity": "O(N) where N is the number of commands to look up", "complexity": "O(N) where N is the number of commands to look up",
"group": "server", "group": "server",
"since": "2.8.13", "since": "2.8.13",
......
{ {
"LIST": { "LIST": {
"summary": "Get an array of Redis command names", "summary": "Returns a list of command names.",
"complexity": "O(N) where N is the total number of Redis commands", "complexity": "O(N) where N is the total number of Redis commands",
"group": "server", "group": "server",
"since": "7.0.0", "since": "7.0.0",
......
{ {
"COMMAND": { "COMMAND": {
"summary": "Get array of Redis command details", "summary": "Returns detailed information about all commands.",
"complexity": "O(N) where N is the total number of Redis commands", "complexity": "O(N) where N is the total number of Redis commands",
"group": "server", "group": "server",
"since": "2.8.13", "since": "2.8.13",
......
{ {
"GET": { "GET": {
"summary": "Get the values of configuration parameters", "summary": "Returns the effective values of configuration parameters.",
"complexity": "O(N) when N is the number of configuration parameters provided", "complexity": "O(N) when N is the number of configuration parameters provided",
"group": "server", "group": "server",
"since": "2.0.0", "since": "2.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": "server", "group": "server",
"since": "5.0.0", "since": "5.0.0",
......
{ {
"RESETSTAT": { "RESETSTAT": {
"summary": "Reset the stats returned by INFO", "summary": "Resets the server's statistics.",
"complexity": "O(1)", "complexity": "O(1)",
"group": "server", "group": "server",
"since": "2.0.0", "since": "2.0.0",
......
{ {
"REWRITE": { "REWRITE": {
"summary": "Rewrite the configuration file with the in memory configuration", "summary": "Persists the effective configuration to file.",
"complexity": "O(1)", "complexity": "O(1)",
"group": "server", "group": "server",
"since": "2.8.0", "since": "2.8.0",
......
{ {
"SET": { "SET": {
"summary": "Set configuration parameters to the given values", "summary": "Sets configuration parameters in-flight.",
"complexity": "O(N) when N is the number of configuration parameters provided", "complexity": "O(N) when N is the number of configuration parameters provided",
"group": "server", "group": "server",
"since": "2.0.0", "since": "2.0.0",
......
{ {
"CONFIG": { "CONFIG": {
"summary": "A container for server configuration commands", "summary": "A container for server configuration commands.",
"complexity": "Depends on subcommand.", "complexity": "Depends on subcommand.",
"group": "server", "group": "server",
"since": "2.0.0", "since": "2.0.0",
......
{ {
"COPY": { "COPY": {
"summary": "Copy a key", "summary": "Copies the value of a key to a new key.",
"complexity": "O(N) worst case for collections, where N is the number of nested items. O(1) for string values.", "complexity": "O(N) worst case for collections, where N is the number of nested items. O(1) for string values.",
"group": "generic", "group": "generic",
"since": "6.2.0", "since": "6.2.0",
......
{ {
"DBSIZE": { "DBSIZE": {
"summary": "Return the number of keys in the selected database", "summary": "Returns the number of keys in the database.",
"complexity": "O(1)", "complexity": "O(1)",
"group": "server", "group": "server",
"since": "1.0.0", "since": "1.0.0",
......
{ {
"DEBUG": { "DEBUG": {
"summary": "A container for debugging commands", "summary": "A container for debugging commands.",
"complexity": "Depends on subcommand.", "complexity": "Depends on subcommand.",
"group": "server", "group": "server",
"since": "1.0.0", "since": "1.0.0",
......
{ {
"DECR": { "DECR": {
"summary": "Decrement the integer value of a key by one", "summary": "Decrements the integer value of a key by one. Uses 0 as initial value if the key doesn't exist.",
"complexity": "O(1)", "complexity": "O(1)",
"group": "string", "group": "string",
"since": "1.0.0", "since": "1.0.0",
......
{ {
"DECRBY": { "DECRBY": {
"summary": "Decrement the integer value of a key by the given number", "summary": "Decrements a number from the integer value of a key. Uses 0 as initial value if the key doesn't exist.",
"complexity": "O(1)", "complexity": "O(1)",
"group": "string", "group": "string",
"since": "1.0.0", "since": "1.0.0",
......
{ {
"DEL": { "DEL": {
"summary": "Delete a key", "summary": "Deletes one or more keys.",
"complexity": "O(N) where N is the number of keys that will be removed. When a key to remove holds a value other than a string, the individual complexity for this key is O(M) where M is the number of elements in the list, set, sorted set or hash. Removing a single key that holds a string value is O(1).", "complexity": "O(N) where N is the number of keys that will be removed. When a key to remove holds a value other than a string, the individual complexity for this key is O(M) where M is the number of elements in the list, set, sorted set or hash. Removing a single key that holds a string value is O(1).",
"group": "generic", "group": "generic",
"since": "1.0.0", "since": "1.0.0",
......
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