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
{ {
"BITCOUNT": { "BITCOUNT": {
"summary": "Count set bits in a string", "summary": "Counts the number of set bits (population counting) in a string.",
"complexity": "O(N)", "complexity": "O(N)",
"group": "bitmap", "group": "bitmap",
"since": "2.6.0", "since": "2.6.0",
......
{ {
"BITFIELD": { "BITFIELD": {
"summary": "Perform arbitrary bitfield integer operations on strings", "summary": "Performs arbitrary bitfield integer operations on strings.",
"complexity": "O(1) for each subcommand specified", "complexity": "O(1) for each subcommand specified",
"group": "bitmap", "group": "bitmap",
"since": "3.2.0", "since": "3.2.0",
......
{ {
"BITFIELD_RO": { "BITFIELD_RO": {
"summary": "Perform arbitrary bitfield integer operations on strings. Read-only variant of BITFIELD", "summary": "Performs arbitrary read-only bitfield integer operations on strings.",
"complexity": "O(1) for each subcommand specified", "complexity": "O(1) for each subcommand specified",
"group": "bitmap", "group": "bitmap",
"since": "6.0.0", "since": "6.0.0",
......
{ {
"BITOP": { "BITOP": {
"summary": "Perform bitwise operations between strings", "summary": "Performs bitwise operations on multiple strings, and stores the result.",
"complexity": "O(N)", "complexity": "O(N)",
"group": "bitmap", "group": "bitmap",
"since": "2.6.0", "since": "2.6.0",
......
{ {
"BITPOS": { "BITPOS": {
"summary": "Find first bit set or clear in a string", "summary": "Finds the first set (1) or clear (0) bit in a string.",
"complexity": "O(N)", "complexity": "O(N)",
"group": "bitmap", "group": "bitmap",
"since": "2.8.7", "since": "2.8.7",
......
{ {
"BLMOVE": { "BLMOVE": {
"summary": "Pop an element from a list, push it to another list and return it; or block until one is available", "summary": "Pops an element from a list, pushes it to another list and returns it. Blocks until an element is available otherwise. Deletes the list if the last element was moved.",
"complexity": "O(1)", "complexity": "O(1)",
"group": "list", "group": "list",
"since": "6.2.0", "since": "6.2.0",
......
{ {
"BLMPOP": { "BLMPOP": {
"summary": "Pop elements from a list, or block until one is available", "summary": "Pops the first element from one of multiple lists. Blocks until an element is available otherwise. Deletes the list if the last element was popped.",
"complexity": "O(N+M) where N is the number of provided keys and M is the number of elements returned.", "complexity": "O(N+M) where N is the number of provided keys and M is the number of elements returned.",
"group": "list", "group": "list",
"since": "7.0.0", "since": "7.0.0",
......
{ {
"BLPOP": { "BLPOP": {
"summary": "Remove and get the first element in a list, or block until one is available", "summary": "Removes and returns the first element in a list. Blocks until an element is available otherwise. Deletes the list if the last element was popped.",
"complexity": "O(N) where N is the number of provided keys.", "complexity": "O(N) where N is the number of provided keys.",
"group": "list", "group": "list",
"since": "2.0.0", "since": "2.0.0",
......
{ {
"BRPOP": { "BRPOP": {
"summary": "Remove and get the last element in a list, or block until one is available", "summary": "Removes and returns the last element in a list. Blocks until an element is available otherwise. Deletes the list if the last element was popped.",
"complexity": "O(N) where N is the number of provided keys.", "complexity": "O(N) where N is the number of provided keys.",
"group": "list", "group": "list",
"since": "2.0.0", "since": "2.0.0",
......
{ {
"BRPOPLPUSH": { "BRPOPLPUSH": {
"summary": "Pop an element from a list, push it to another list and return it; or block until one is available", "summary": "Pops an element from a list, pushes it to another list and returns it. Block until an element is available otherwise. Deletes the list if the last element was popped.",
"complexity": "O(1)", "complexity": "O(1)",
"group": "list", "group": "list",
"since": "2.2.0", "since": "2.2.0",
......
{ {
"BZMPOP": { "BZMPOP": {
"summary": "Remove and return members with scores in a sorted set or block until one is available", "summary": "Removes and returns a member by score from one or more sorted sets. Blocks until a member is available otherwise. Deletes the sorted set if the last element was popped.",
"complexity": "O(K) + O(M*log(N)) where K is the number of provided keys, N being the number of elements in the sorted set, and M being the number of elements popped.", "complexity": "O(K) + O(M*log(N)) where K is the number of provided keys, N being the number of elements in the sorted set, and M being the number of elements popped.",
"group": "sorted_set", "group": "sorted_set",
"since": "7.0.0", "since": "7.0.0",
......
{ {
"BZPOPMAX": { "BZPOPMAX": {
"summary": "Remove and return the member with the highest score from one or more sorted sets, or block until one is available", "summary": "Removes and returns the member with the highest score from one or more sorted sets. Blocks until a member available otherwise. Deletes the sorted set if the last element was popped.",
"complexity": "O(log(N)) with N being the number of elements in the sorted set.", "complexity": "O(log(N)) with N being the number of elements in the sorted set.",
"group": "sorted_set", "group": "sorted_set",
"since": "5.0.0", "since": "5.0.0",
......
{ {
"BZPOPMIN": { "BZPOPMIN": {
"summary": "Remove and return the member with the lowest score from one or more sorted sets, or block until one is available", "summary": "Removes and returns the member with the lowest score from one or more sorted sets. Blocks until a member is available otherwise. Deletes the sorted set if the last element was popped.",
"complexity": "O(log(N)) with N being the number of elements in the sorted set.", "complexity": "O(log(N)) with N being the number of elements in the sorted set.",
"group": "sorted_set", "group": "sorted_set",
"since": "5.0.0", "since": "5.0.0",
......
{ {
"CACHING": { "CACHING": {
"summary": "Instruct the server about tracking or not keys in the next request", "summary": "Instructs the server whether to track the keys in the next request.",
"complexity": "O(1)", "complexity": "O(1)",
"group": "connection", "group": "connection",
"since": "6.0.0", "since": "6.0.0",
......
{ {
"GETNAME": { "GETNAME": {
"summary": "Get the current connection name", "summary": "Returns the name of the connection.",
"complexity": "O(1)", "complexity": "O(1)",
"group": "connection", "group": "connection",
"since": "2.6.9", "since": "2.6.9",
......
{ {
"GETREDIR": { "GETREDIR": {
"summary": "Get tracking notifications redirection client ID if any", "summary": "Returns the client ID to which the connection's tracking notifications are redirected.",
"complexity": "O(1)", "complexity": "O(1)",
"group": "connection", "group": "connection",
"since": "6.0.0", "since": "6.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": "connection", "group": "connection",
"since": "5.0.0", "since": "5.0.0",
......
{ {
"ID": { "ID": {
"summary": "Returns the client ID for the current connection", "summary": "Returns the unique client ID of the connection.",
"complexity": "O(1)", "complexity": "O(1)",
"group": "connection", "group": "connection",
"since": "5.0.0", "since": "5.0.0",
......
{ {
"INFO": { "INFO": {
"summary": "Returns information about the current client connection.", "summary": "Returns information about the connection.",
"complexity": "O(1)", "complexity": "O(1)",
"group": "connection", "group": "connection",
"since": "6.2.0", "since": "6.2.0",
......
{ {
"KILL": { "KILL": {
"summary": "Kill the connection of a client", "summary": "Terminates open connections.",
"complexity": "O(N) where N is the number of client connections", "complexity": "O(N) where N is the number of client connections",
"group": "connection", "group": "connection",
"since": "2.4.0", "since": "2.4.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