diff options
| author | Itamar Haber <itamar@redis.com> | 2023-03-29 20:48:59 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-03-29 20:48:59 +0300 |
| commit | 0c3b8b7e90ea242640a417abb5c40f30dfc3e036 (patch) | |
| tree | 6eac70dd7a4feb4b7338d589fd6c221992b96970 /tests | |
| parent | cb1717865804fdb0561e728d2f3a0a1138099d9d (diff) | |
| download | redis-0c3b8b7e90ea242640a417abb5c40f30dfc3e036.tar.gz | |
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.
Diffstat (limited to 'tests')
| -rw-r--r-- | tests/modules/cmdintrospection.c | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/tests/modules/cmdintrospection.c b/tests/modules/cmdintrospection.c index dd9fb7f60..1a5e4863b 100644 --- a/tests/modules/cmdintrospection.c +++ b/tests/modules/cmdintrospection.c @@ -23,7 +23,7 @@ int RedisModule_OnLoad(RedisModuleCtx *ctx, RedisModuleString **argv, int argc) RedisModuleCommandInfo info = { .version = REDISMODULE_COMMAND_INFO_VERSION, .arity = -5, - .summary = "Appends a new entry to a stream", + .summary = "Appends a new message to a stream. Creates the key if it doesn't exist.", .since = "5.0.0", .complexity = "O(1) when adding a new entry, O(N) when trimming where N being the number of entries evicted.", .tips = "nondeterministic_output", |