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
{
"INCR": {
"summary": "Increment the integer value of a key by one",
"summary": "Increments the integer value of a key by one. Uses 0 as initial value if the key doesn't exist.",
"complexity": "O(1)",
"group": "string",
"since": "1.0.0",
......
{
"INCRBY": {
"summary": "Increment the integer value of a key by the given amount",
"summary": "Increments the integer value of a key by a number. Uses 0 as initial value if the key doesn't exist.",
"complexity": "O(1)",
"group": "string",
"since": "1.0.0",
......
{
"INCRBYFLOAT": {
"summary": "Increment the float value of a key by the given amount",
"summary": "Increment the floating point value of a key by a number. Uses 0 as initial value if the key doesn't exist.",
"complexity": "O(1)",
"group": "string",
"since": "2.6.0",
......
{
"INFO": {
"summary": "Get information and statistics about the server",
"summary": "Returns information and statistics about the server.",
"complexity": "O(1)",
"group": "server",
"since": "1.0.0",
......
{
"KEYS": {
"summary": "Find all keys matching the given pattern",
"summary": "Returns all key names that match a pattern.",
"complexity": "O(N) with N being the number of keys in the database, under the assumption that the key names in the database and the given pattern have limited length.",
"group": "generic",
"since": "1.0.0",
......
{
"LASTSAVE": {
"summary": "Get the UNIX time stamp of the last successful save to disk",
"summary": "Returns the Unix timestamp of the last successful save to disk.",
"complexity": "O(1)",
"group": "server",
"since": "1.0.0",
......
{
"DOCTOR": {
"summary": "Return a human readable latency analysis report.",
"summary": "Returns a human-readable latency analysis report.",
"complexity": "O(1)",
"group": "server",
"since": "2.8.13",
......
{
"GRAPH": {
"summary": "Return a latency graph for the event.",
"summary": "Returns a latency graph for an event.",
"complexity": "O(1)",
"group": "server",
"since": "2.8.13",
......
{
"HELP": {
"summary": "Show helpful text about the different subcommands.",
"summary": "Returns helpful text about the different subcommands.",
"complexity": "O(1)",
"group": "server",
"since": "2.8.13",
......
{
"HISTOGRAM": {
"summary": "Return the cumulative distribution of latencies of a subset of commands or all.",
"summary": "Returns the cumulative distribution of latencies of a subset or all commands.",
"complexity": "O(N) where N is the number of commands with latency information being retrieved.",
"group": "server",
"since": "7.0.0",
......
{
"HISTORY": {
"summary": "Return timestamp-latency samples for the event.",
"summary": "Returns timestamp-latency samples for an event.",
"complexity": "O(1)",
"group": "server",
"since": "2.8.13",
......
{
"LATEST": {
"summary": "Return the latest latency samples for all events.",
"summary": "Returns the latest latency samples for all events.",
"complexity": "O(1)",
"group": "server",
"since": "2.8.13",
......
{
"RESET": {
"summary": "Reset latency data for one or more events.",
"summary": "Resets the latency data for one or more events.",
"complexity": "O(1)",
"group": "server",
"since": "2.8.13",
......
{
"LATENCY": {
"summary": "A container for latency diagnostics commands",
"summary": "A container for latency diagnostics commands.",
"complexity": "Depends on subcommand.",
"group": "server",
"since": "2.8.13",
......
{
"LCS": {
"summary": "Find longest common substring",
"summary": "Finds the longest common substring.",
"complexity": "O(N*M) where N and M are the lengths of s1 and s2, respectively",
"group": "string",
"since": "7.0.0",
......
{
"LINDEX": {
"summary": "Get an element from a list by its index",
"summary": "Returns an element from a list by its index.",
"complexity": "O(N) where N is the number of elements to traverse to get to the element at index. This makes asking for the first or the last element of the list O(1).",
"group": "list",
"since": "1.0.0",
......
{
"LINSERT": {
"summary": "Insert an element before or after another element in a list",
"summary": "Inserts an element before or after another element in a list.",
"complexity": "O(N) where N is the number of elements to traverse before seeing the value pivot. This means that inserting somewhere on the left end on the list (head) can be considered O(1) and inserting somewhere on the right end (tail) is O(N).",
"group": "list",
"since": "2.2.0",
......
{
"LLEN": {
"summary": "Get the length of a list",
"summary": "Returns the length of a list.",
"complexity": "O(1)",
"group": "list",
"since": "1.0.0",
......
{
"LMOVE": {
"summary": "Pop an element from a list, push it to another list and return it",
"summary": "Returns an element after popping it from one list and pushing it to another. Deletes the list if the last element was moved.",
"complexity": "O(1)",
"group": "list",
"since": "6.2.0",
......
{
"LMPOP": {
"summary": "Pop elements from a list",
"summary": "Returns multiple elements from a list after removing them. 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.",
"group": "list",
"since": "7.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