From 0c3b8b7e90ea242640a417abb5c40f30dfc3e036 Mon Sep 17 00:00:00 2001 From: Itamar Haber Date: Wed, 29 Mar 2023 20:48:59 +0300 Subject: 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. --- src/commands/blmpop.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'src/commands/blmpop.json') diff --git a/src/commands/blmpop.json b/src/commands/blmpop.json index 419eb3e6f..48bfa3e89 100644 --- a/src/commands/blmpop.json +++ b/src/commands/blmpop.json @@ -1,6 +1,6 @@ { "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.", "group": "list", "since": "7.0.0", -- cgit v1.2.1