Fix inconsistencies in the json command file descriptions (#63)

Grammar. Use full sentences. Signed-off-by: Pragnesh <pg.radadia@gmail.com>
valkey-io · Apr 2, 2024 · 42e0063 · 42e0063
1 parent 621edba
commit 42e0063
Show file tree

Hide file tree

Showing 78 changed files with 298 additions and 298 deletions.
diff --git a/src/commands/acl-cat.json b/src/commands/acl-cat.json
@@ -24,7 +24,7 @@
                 },
                 {
                     "type": "array",
-                    "description": "In case `category` was given, list of commands that fall under the provided ACL category",
+                    "description": "In case `category` was given, list of commands that fall under the provided ACL category.",
                     "items": {
                         "type": "string"
                     }

diff --git a/src/commands/acl-deluser.json b/src/commands/acl-deluser.json
@@ -20,7 +20,7 @@
         ],        
         "reply_schema": {
             "type": "integer",
-            "description": "The number of users that were deleted"
+            "description": "The number of users that were deleted."
         },
         "arguments": [
             {

diff --git a/src/commands/acl-getuser.json b/src/commands/acl-getuser.json
@@ -33,7 +33,7 @@
         "reply_schema": {
             "oneOf": [
                 {
-                    "description": "a set of ACL rule definitions for the user",
+                    "description": "A set of ACL rule definitions for the user.",
                     "type": "object",
                     "additionalProperties": false,
                     "properties": {
@@ -50,15 +50,15 @@
                             }
                         },
                         "commands": {
-                            "description": "root selector's commands",
+                            "description": "Root selector's commands.",
                             "type": "string"
                         },
                         "keys": {
-                            "description": "root selector's keys",
+                            "description": "Root selector's keys.",
                             "type": "string"
                         },
                         "channels": {
-                            "description": "root selector's channels",
+                            "description": "Root selector's channels.",
                             "type": "string"
                         },
                         "selectors": {

diff --git a/src/commands/acl-help.json b/src/commands/acl-help.json
@@ -14,7 +14,7 @@
         ],
         "reply_schema": {
             "type": "array",
-            "description": "A list of subcommands and their description",
+            "description": "A list of subcommands and their description.",
             "items": {
                 "type": "string"
             }

diff --git a/src/commands/acl-list.json b/src/commands/acl-list.json
@@ -16,7 +16,7 @@
         ],
         "reply_schema": {
             "type": "array",
-            "description": "A list of currently active ACL rules",
+            "description": "A list of currently active ACL rules.",
             "items": {
                 "type": "string"
             }

diff --git a/src/commands/acl-users.json b/src/commands/acl-users.json
@@ -16,7 +16,7 @@
         ],
         "reply_schema": {
             "type": "array",
-            "description": "List of existing ACL users",
+            "description": "List of existing ACL users.",
             "items": {
                 "type": "string"
             }

diff --git a/src/commands/bitop.json b/src/commands/bitop.json
@@ -91,7 +91,7 @@
             }
         ],
         "reply_schema": {
-            "description": "the size of the string stored in the destination key, that is equal to the size of the longest input string",
+            "description": "The size of the string stored in the destination key, that is equal to the size of the longest input string.",
             "type": "integer",
             "minimum": 0
         }

diff --git a/src/commands/bitpos.json b/src/commands/bitpos.json
@@ -92,12 +92,12 @@
         "reply_schema": {
             "oneOf": [
                 {
-                    "description": "the position of the first bit set to 1 or 0 according to the request",
+                    "description": "The position of the first bit set to 1 or 0 according to the request.",
                     "type": "integer",
                     "minimum": 0
                 },
                 {
-                    "description": "In case the `bit` argument is 1 and the string is empty or composed of just zero bytes",
+                    "description": "In case the `bit` argument is 1 and the string is empty or composed of just zero bytes.",
                     "const": -1
                 }
             ]

diff --git a/src/commands/client-info.json b/src/commands/client-info.json
@@ -20,7 +20,7 @@
             "NONDETERMINISTIC_OUTPUT"
         ],
         "reply_schema": {
-            "description": "a unique string, as described at the CLIENT LIST page, for the current client",
+            "description": "A unique string, as described at the CLIENT LIST page, for the current client.",
             "type": "string"
         }
     }

diff --git a/src/commands/client-kill.json b/src/commands/client-kill.json
@@ -156,11 +156,11 @@
         "reply_schema": {
             "oneOf": [
                 {
-                    "description": "when called in 3 argument format",
+                    "description": "When called in 3 argument format.",
                     "const": "OK"
                 },
                 {
-                    "description": "when called in filter/value format, the number of clients killed",
+                    "description": "When called in filter/value format, the number of clients killed.",
                     "type": "integer",
                     "minimum": 0
                 }

diff --git a/src/commands/client-tracking.json b/src/commands/client-tracking.json
@@ -73,7 +73,7 @@
             }
         ],
         "reply_schema": {
-            "description": "if the client was successfully put into or taken out of tracking mode",
+            "description": "If the client was successfully put into or taken out of tracking mode.",
             "const": "OK"
         }
     }

diff --git a/src/commands/client-unblock.json b/src/commands/client-unblock.json
@@ -21,11 +21,11 @@
             "oneOf": [
                 {
                     "const": 0,
-                    "description": "if the client was unblocked successfully"
+                    "description": "If the client was unblocked successfully."
                 },
                 {
                     "const": 1,
-                    "description": "if the client wasn't unblocked"
+                    "description": "If the client wasn't unblocked."
                 }
             ]
         },

diff --git a/src/commands/cluster-bumpepoch.json b/src/commands/cluster-bumpepoch.json
@@ -18,12 +18,12 @@
         "reply_schema": {
             "oneOf": [
                 {
-                    "description": "if the epoch was incremented",
+                    "description": "If the epoch was incremented.",
                     "type": "string",
                     "pattern": "^BUMPED [0-9]*$"
                 },
                 {
-                    "description": "if the node already has the greatest config epoch in the cluster",
+                    "description": "If the node already has the greatest config epoch in the cluster.",
                     "type": "string",
                     "pattern": "^STILL [0-9]*$"
                 }

diff --git a/src/commands/cluster-count-failure-reports.json b/src/commands/cluster-count-failure-reports.json
@@ -21,7 +21,7 @@
             }
         ],
         "reply_schema": {
-            "description": "the number of active failure reports for the node",
+            "description": "The number of active failure reports for the node.",
             "type": "integer",
             "minimum": 0
         }

diff --git a/src/commands/cluster-countkeysinslot.json b/src/commands/cluster-countkeysinslot.json
@@ -17,7 +17,7 @@
             }
         ],
         "reply_schema": {
-            "description": "The number of keys in the specified hash slot",
+            "description": "The number of keys in the specified hash slot.",
             "type": "integer",
             "minimum": 0
         }

diff --git a/src/commands/cluster-getkeysinslot.json b/src/commands/cluster-getkeysinslot.json
@@ -24,10 +24,10 @@
             }
         ],
         "reply_schema": {
-            "description": "an array with up to count elements",
+            "description": "An array with up to count elements.",
             "type": "array",
             "items": {
-                "description": "key name",
+                "description": "Key name.",
                 "type": "string"
             }
         }

diff --git a/src/commands/cluster-links.json b/src/commands/cluster-links.json
@@ -14,7 +14,7 @@
             "NONDETERMINISTIC_OUTPUT"
         ],
         "reply_schema": {
-            "description": "an array of cluster links and their attributes",
+            "description": "An array of cluster links and their attributes.",
             "type": "array",
             "items": {
                 "type": "object",
@@ -23,33 +23,33 @@
                         "description": "This link is established by the local node _to_ the peer, or accepted by the local node _from_ the peer.",
                         "oneOf": [
                             {
-                                "description": "connection initiated from peer",
+                                "description": "Connection initiated from peer.",
                                 "const": "from"
                             },
                             {
-                                "description": "connection initiated to peer",
+                                "description": "Connection initiated to peer.",
                                 "const": "to"
                             }
                         ]
                     },
                     "node": {
-                        "description": "the node id of the peer",
+                        "description": "The node id of the peer.",
                         "type": "string"
                     },
                     "create-time": {
-                        "description": "unix time creation time of the link. (In the case of a _to_ link, this is the time when the TCP link is created by the local node, not the time when it is actually established.)",
+                        "description": "Unix time creation time of the link. (In the case of a _to_ link, this is the time when the TCP link is created by the local node, not the time when it is actually established.)",
                         "type": "integer"
                     },
                     "events": {
-                        "description": "events currently registered for the link. r means readable event, w means writable event",
+                        "description": "Events currently registered for the link. r means readable event, w means writable event.",
                         "type": "string"
                     },
                     "send-buffer-allocated": {
-                        "description": "allocated size of the link's send buffer, which is used to buffer outgoing messages toward the peer",
+                        "description": "Allocated size of the link's send buffer, which is used to buffer outgoing messages toward the peer.",
                         "type": "integer"
                     },
                     "send-buffer-used": {
-                        "description": "size of the portion of the link's send buffer that is currently holding data(messages)",
+                        "description": "Size of the portion of the link's send buffer that is currently holding data(messages).",
                         "type": "integer"
                     }
                 },

diff --git a/src/commands/cluster-myid.json b/src/commands/cluster-myid.json
@@ -11,7 +11,7 @@
             "STALE"
         ],
         "reply_schema": {
-            "description": "the node id",
+            "description": "The node id.",
             "type": "string"
         }
     }

diff --git a/src/commands/cluster-myshardid.json b/src/commands/cluster-myshardid.json
@@ -15,7 +15,7 @@
             "NONDETERMINISTIC_OUTPUT"
         ],
         "reply_schema": {
-            "description": "the node's shard id",
+            "description": "The node's shard id.",
             "type": "string"
         }
     }

diff --git a/src/commands/cluster-nodes.json b/src/commands/cluster-nodes.json
@@ -14,7 +14,7 @@
             "NONDETERMINISTIC_OUTPUT"
         ],
         "reply_schema": {
-            "description": "the serialized cluster configuration",
+            "description": "The serialized cluster configuration.",
             "type": "string"
         }
     }

diff --git a/src/commands/cluster-replicas.json b/src/commands/cluster-replicas.json
@@ -21,11 +21,11 @@
             }
         ],
         "reply_schema": {
-            "description": "a list of replica nodes replicating from the specified master node provided in the same format used by CLUSTER NODES",
+            "description": "A list of replica nodes replicating from the specified master node provided in the same format used by CLUSTER NODES.",
             "type": "array",
             "items": {
                 "type": "string",
-                "description": "the serialized cluster configuration"
+                "description": "The serialized cluster configuration."
             }
         }
     }

diff --git a/src/commands/cluster-shards.json b/src/commands/cluster-shards.json
@@ -16,21 +16,21 @@
             "NONDETERMINISTIC_OUTPUT"
         ],
         "reply_schema": {
-            "description": "a nested list of a map of hash ranges and shard nodes describing individual shards",
+            "description": "A nested list of a map of hash ranges and shard nodes describing individual shards.",
             "type": "array",
             "items": {
                 "type": "object",
                 "additionalProperties": false,
                 "properties": {
                     "slots": {
-                        "description": "an even number element array specifying the start and end slot numbers for slot ranges owned by this shard",
+                        "description": "An even number element array specifying the start and end slot numbers for slot ranges owned by this shard.",
                         "type": "array",
                         "items": {
                             "type": "integer"
                         }
                     },
                     "nodes": {
-                        "description": "nodes that handle these slot ranges",
+                        "description": "Nodes that handle these slot ranges.",
                         "type": "array",
                         "items": {
                             "type": "object",

diff --git a/src/commands/cluster-slaves.json b/src/commands/cluster-slaves.json
@@ -26,11 +26,11 @@
             }
         ],
         "reply_schema": {
-            "description": "a list of replica nodes replicating from the specified master node provided in the same format used by CLUSTER NODES",
+            "description": "A list of replica nodes replicating from the specified master node provided in the same format used by CLUSTER NODES.",
             "type": "array",
             "items": {
                 "type": "string",
-                "description": "the serialized cluster configuration"
+                "description": "The serialized cluster configuration."
             }
         }
     }