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
{ {
"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": "scripting", "group": "scripting",
"since": "7.0.0", "since": "7.0.0",
......
{ {
"KILL": { "KILL": {
"summary": "Kill the function currently in execution.", "summary": "Terminates a function during execution.",
"complexity": "O(1)", "complexity": "O(1)",
"group": "scripting", "group": "scripting",
"since": "7.0.0", "since": "7.0.0",
......
{ {
"LIST": { "LIST": {
"summary": "List information about all the functions", "summary": "Returns information about all libraries.",
"complexity": "O(N) where N is the number of functions", "complexity": "O(N) where N is the number of functions",
"group": "scripting", "group": "scripting",
"since": "7.0.0", "since": "7.0.0",
......
{ {
"LOAD": { "LOAD": {
"summary": "Create a function with the given arguments (name, code, description)", "summary": "Creates a library.",
"complexity": "O(1) (considering compilation time is redundant)", "complexity": "O(1) (considering compilation time is redundant)",
"group": "scripting", "group": "scripting",
"since": "7.0.0", "since": "7.0.0",
......
{ {
"RESTORE": { "RESTORE": {
"summary": "Restore all the functions on the given payload", "summary": "Restores all libraries from a payload.",
"complexity": "O(N) where N is the number of functions on the payload", "complexity": "O(N) where N is the number of functions on the payload",
"group": "scripting", "group": "scripting",
"since": "7.0.0", "since": "7.0.0",
......
{ {
"STATS": { "STATS": {
"summary": "Return information about the function currently running (name, description, duration)", "summary": "Returns information about a function during execution.",
"complexity": "O(1)", "complexity": "O(1)",
"group": "scripting", "group": "scripting",
"since": "7.0.0", "since": "7.0.0",
......
{ {
"FUNCTION": { "FUNCTION": {
"summary": "A container for function commands", "summary": "A container for function commands.",
"complexity": "Depends on subcommand.", "complexity": "Depends on subcommand.",
"group": "scripting", "group": "scripting",
"since": "7.0.0", "since": "7.0.0",
......
{ {
"GEOADD": { "GEOADD": {
"summary": "Add one or more geospatial items in the geospatial index represented using a sorted set", "summary": "Adds one or more members to a geospatial index. The key is created if it doesn't exist.",
"complexity": "O(log(N)) for each item added, where N is the number of elements in the sorted set.", "complexity": "O(log(N)) for each item added, where N is the number of elements in the sorted set.",
"group": "geo", "group": "geo",
"since": "3.2.0", "since": "3.2.0",
......
{ {
"GEODIST": { "GEODIST": {
"summary": "Returns the distance between two members of a geospatial index", "summary": "Returns the distance between two members of a geospatial index.",
"complexity": "O(log(N))", "complexity": "O(log(N))",
"group": "geo", "group": "geo",
"since": "3.2.0", "since": "3.2.0",
......
{ {
"GEOHASH": { "GEOHASH": {
"summary": "Returns members of a geospatial index as standard geohash strings", "summary": "Returns members from a geospatial index as geohash strings.",
"complexity": "O(log(N)) for each member requested, where N is the number of elements in the sorted set.", "complexity": "O(log(N)) for each member requested, where N is the number of elements in the sorted set.",
"group": "geo", "group": "geo",
"since": "3.2.0", "since": "3.2.0",
......
{ {
"GEOPOS": { "GEOPOS": {
"summary": "Returns longitude and latitude of members of a geospatial index", "summary": "Returns the longitude and latitude of members from a geospatial index.",
"complexity": "O(N) where N is the number of members requested.", "complexity": "O(N) where N is the number of members requested.",
"group": "geo", "group": "geo",
"since": "3.2.0", "since": "3.2.0",
......
{ {
"GEORADIUS": { "GEORADIUS": {
"summary": "Query a sorted set representing a geospatial index to fetch members matching a given maximum distance from a point", "summary": "Queries a geospatial index for members within a distance from a coordinate, optionally stores the result.",
"complexity": "O(N+log(M)) where N is the number of elements inside the bounding box of the circular area delimited by center and radius and M is the number of items inside the index.", "complexity": "O(N+log(M)) where N is the number of elements inside the bounding box of the circular area delimited by center and radius and M is the number of items inside the index.",
"group": "geo", "group": "geo",
"since": "3.2.0", "since": "3.2.0",
......
{ {
"GEORADIUS_RO": { "GEORADIUS_RO": {
"summary": "A read-only variant for GEORADIUS", "summary": "Returns members from a geospatial index that are within a distance from a coordinate.",
"complexity": "O(N+log(M)) where N is the number of elements inside the bounding box of the circular area delimited by center and radius and M is the number of items inside the index.", "complexity": "O(N+log(M)) where N is the number of elements inside the bounding box of the circular area delimited by center and radius and M is the number of items inside the index.",
"group": "geo", "group": "geo",
"since": "3.2.10", "since": "3.2.10",
......
{ {
"GEORADIUSBYMEMBER": { "GEORADIUSBYMEMBER": {
"summary": "Query a sorted set representing a geospatial index to fetch members matching a given maximum distance from a member", "summary": "Queries a geospatial index for members within a distance from a member, optionally stores the result.",
"complexity": "O(N+log(M)) where N is the number of elements inside the bounding box of the circular area delimited by center and radius and M is the number of items inside the index.", "complexity": "O(N+log(M)) where N is the number of elements inside the bounding box of the circular area delimited by center and radius and M is the number of items inside the index.",
"group": "geo", "group": "geo",
"since": "3.2.0", "since": "3.2.0",
......
{ {
"GEORADIUSBYMEMBER_RO": { "GEORADIUSBYMEMBER_RO": {
"summary": "A read-only variant for GEORADIUSBYMEMBER", "summary": "Returns members from a geospatial index that are within a distance from a member.",
"complexity": "O(N+log(M)) where N is the number of elements inside the bounding box of the circular area delimited by center and radius and M is the number of items inside the index.", "complexity": "O(N+log(M)) where N is the number of elements inside the bounding box of the circular area delimited by center and radius and M is the number of items inside the index.",
"group": "geo", "group": "geo",
"since": "3.2.10", "since": "3.2.10",
......
{ {
"GEOSEARCH": { "GEOSEARCH": {
"summary": "Query a sorted set representing a geospatial index to fetch members inside an area of a box or a circle.", "summary": "Queries a geospatial index for members inside an area of a box or a circle.",
"complexity": "O(N+log(M)) where N is the number of elements in the grid-aligned bounding box area around the shape provided as the filter and M is the number of items inside the shape", "complexity": "O(N+log(M)) where N is the number of elements in the grid-aligned bounding box area around the shape provided as the filter and M is the number of items inside the shape",
"group": "geo", "group": "geo",
"since": "6.2.0", "since": "6.2.0",
......
{ {
"GEOSEARCHSTORE": { "GEOSEARCHSTORE": {
"summary": "Query a sorted set representing a geospatial index to fetch members inside an area of a box or a circle, and store the result in another key.", "summary": "Queries a geospatial index for members inside an area of a box or a circle, optionally stores the result.",
"complexity": "O(N+log(M)) where N is the number of elements in the grid-aligned bounding box area around the shape provided as the filter and M is the number of items inside the shape", "complexity": "O(N+log(M)) where N is the number of elements in the grid-aligned bounding box area around the shape provided as the filter and M is the number of items inside the shape",
"group": "geo", "group": "geo",
"since": "6.2.0", "since": "6.2.0",
......
{ {
"GET": { "GET": {
"summary": "Get the value of a key", "summary": "Returns the string value of a key.",
"complexity": "O(1)", "complexity": "O(1)",
"group": "string", "group": "string",
"since": "1.0.0", "since": "1.0.0",
......
{ {
"GETBIT": { "GETBIT": {
"summary": "Returns the bit value at offset in the string value stored at key", "summary": "Returns a bit value by offset.",
"complexity": "O(1)", "complexity": "O(1)",
"group": "bitmap", "group": "bitmap",
"since": "2.2.0", "since": "2.2.0",
......
{ {
"GETDEL": { "GETDEL": {
"summary": "Get the value of a key and delete the key", "summary": "Returns the string value of a key after deleting the key.",
"complexity": "O(1)", "complexity": "O(1)",
"group": "string", "group": "string",
"since": "6.2.0", "since": "6.2.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