DEV: add RESP2/3 return information to the t-digest commands

Author: dwdougherty

content/commands/tdigest.add.md

@@ -40,16 +40,14 @@ Adds one or more observations to a t-digest sketch.
 ## Required arguments
 
 <details open><summary><code>key</code></summary> 
-is key name for an existing t-digest sketch.
-</details>
 
-<details open><summary><code>value</code></summary> 
-is value of an observation (floating-point).
+is the key name for an existing t-digest sketch.
 </details>
 
-## Return value
+<details open><summary><code>value</code></summary> 
 
-[Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) - `OK` if executed correctly, or [] otherwise.
+is the floating-point value of an observation.
+</details>
 
 ## Examples
 
@@ -62,3 +60,23 @@ OK
 redis> TDIGEST.ADD t string
 (error) ERR T-Digest: error parsing val parameter
 {{< / highlight >}}
+
+## Return information
+
+{{< multitabs id=“tdigest-add-return-info" 
+    tab1="RESP2" 
+    tab2="RESP3" >}}
+
+One of the following:
+
+* [Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) `OK` if executed correctly.
+* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: the given key does not exist or the value parameter is of the incorrect type.
+
+-tab-sep-
+
+One of the following:
+
+* [Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) `OK` if executed correctly.
+* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: the given key does not exist or the value parameter is of the incorrect type.
+
+{{< /multitabs >}}

content/commands/tdigest.byrank.md

@@ -19,51 +19,40 @@ categories:
 - kubernetes
 - clients
 complexity: O(N) where N is the number of ranks specified.
-description: Returns, for each input rank, an estimation of the value (floating-point)
+description: Returns, for each input rank, a floating-point estimation of the value
   with that rank
 group: tdigest
 hidden: false
 linkTitle: TDIGEST.BYRANK
 module: Bloom
 since: 2.4.0
 stack_path: docs/data-types/probabilistic
-summary: Returns, for each input rank, an estimation of the value (floating-point)
+summary: Returns, for each input rank, a floating-point estimation of the value
   with that rank
 syntax_fmt: TDIGEST.BYRANK key rank [rank ...]
 syntax_str: rank [rank ...]
 title: TDIGEST.BYRANK
 ---
-Returns, for each input rank, an estimation of the value (floating-point) with that rank.
-
-Multiple estimations can be retrieved in a signle call.
+Returns, for each input rank, a floating-point estimation of the value with that rank.
+Multiple estimations can be retrieved in a single call.
 
 ## Required arguments
 
 <details open><summary><code>key</code></summary>
-is key name for an existing t-digest sketch.
+
+is the key name of an existing t-digest sketch.
 </details>
 
 <details open><summary><code>rank</code></summary>
 
-Rank, for which the value should be retrieved.
+Ranks for which the values should be retrieved.
 
 0 is the rank of the value of the smallest observation.
 
-_n_-1 is the rank of the value of the largest observation; _n_ denotes the number of observations added to the sketch.
-
+_n_-1 is the rank of the value of the largest observation, where _n_ denotes the number of observations that have been added to the sketch.
 </details>
 
-## Return value
-
-[Array reply]({{< relref "/develop/reference/protocol-spec#arrays" >}}) - an array of floating-points populated with value_1, value_2, ..., value_R:
-
-- Return an accurate result when `rank` is 0 (the value of the smallest observation)
-- Return an accurate result when `rank` is _n_-1 (the value of the largest observation), where _n_ denotes the number of observations added to the sketch.
-- Return 'inf' when `rank` is equal to _n_ or larger than _n_
-
-All values are 'nan' if the sketch is empty.
-
-## Examples
+## Example
 
 {{< highlight bash >}}
 redis> TDIGEST.CREATE t COMPRESSION 1000
@@ -88,3 +77,31 @@ redis> TDIGEST.BYRANK t 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
 15) "5"
 16) "inf"
 {{< / highlight >}}
+
+## Return information
+
+{{< multitabs id=“tdigest-byrank-return-info" 
+    tab1="RESP2" 
+    tab2="RESP3" >}}
+
+One of the following:
+
+* [Array]({{< relref "/develop/reference/protocol-spec#arrays" >}}) of [bulk strings]({{< relref "/develop/reference/protocol-spec#bulk-strings" >}}) as floating-points, populated with value_1, value_2, ..., value_R:
+    * an accurate result when `rank` is `0`, the value of the smallest observation.
+    * an accurate result when `rank` is _n_-1, the value of the largest observation, where _n_ denotes the number of observations added to the sketch.
+    * `inf` when `rank` is equal to _n_ or larger than _n_.
+    * `nan` for all ranks when the given sketch is empty.
+* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: the given key does not exist or is of an incorrect type, rank parsing errors, or incorrect number of arguments.
+
+-tab-sep-
+
+One of the following:
+
+* [Array]({{< relref "/develop/reference/protocol-spec#arrays" >}}) of [doubles]({{< relref "/develop/reference/protocol-spec#doubles" >}}) as floating-points, populated with value_1, value_2, ..., value_R:
+    * an accurate result when `rank` is `0`, the value of the smallest observation.
+    * an accurate result when `rank` is _n_-1, the value of the largest observation, where _n_ denotes the number of observations added to the sketch.
+    * `inf` when `rank` is equal to _n_ or larger than _n_.
+    * `nan` for all ranks when the given sketch is empty.
+* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: the given key does not exist or is of an incorrect type, rank parsing errors, or incorrect number of arguments.
+
+{{< /multitabs >}}

content/commands/tdigest.byrevrank.md

@@ -19,49 +19,39 @@ categories:
 - kubernetes
 - clients
 complexity: O(N) where N is the number of reverse ranks specified.
-description: Returns, for each input reverse rank, an estimation of the value (floating-point)
+description: Returns, for each input reverse rank, an estimation of the floating-point value
   with that reverse rank
 group: tdigest
 hidden: false
 linkTitle: TDIGEST.BYREVRANK
 module: Bloom
 since: 2.4.0
 stack_path: docs/data-types/probabilistic
-summary: Returns, for each input reverse rank, an estimation of the value (floating-point)
+summary: Returns, for each input reverse rank, an estimation of the floating-point value
   with that reverse rank
 syntax_fmt: TDIGEST.BYREVRANK key reverse_rank [reverse_rank ...]
 syntax_str: reverse_rank [reverse_rank ...]
 title: TDIGEST.BYREVRANK
 ---
-Returns, for each input reverse rank, an estimation of the value (floating-point) with that reverse rank.
-
+Returns, for each input reverse rank (`revrank`), an estimation of the floating-point value with that reverse rank.
 Multiple estimations can be retrieved in a single call.
 
 ## Required arguments
 
 <details open><summary><code>key</code></summary>
-is key name for an existing t-digest sketch.
+
+is the key name of an existing t-digest sketch.
 </details>
 
 <details open><summary><code>revrank</code></summary>
 
-Reverse rank, for which the value should be retrieved.
+Reverse ranks for which the values should be retrieved.
 
 0 is the reverse rank of the value of the largest observation.
 
-_n_-1 is the reverse rank of the value of the smallest observation; _n_ denotes the number of observations added to the sketch.
+_n_-1 is the reverse rank of the value of the smallest observation, where _n_ denotes the number of observations added to the sketch.
 </details>
 
-## Return value
-
-[Array reply]({{< relref "/develop/reference/protocol-spec#arrays" >}}) - an array of floating-points populated with value_1, value_2, ..., value_R:
-
-- Return an accurate result when `revrank` is 0 (the value of the largest observation)
-- Return an accurate result when `revrank` is _n_-1 (the value of the smallest observation), where _n_ denotes the number of observations added to the sketch.
-- Return '-inf' when `revrank` is equal to _n_ or larger than _n_
-
-All values are 'nan' if the sketch is empty.
-
 ## Examples
 
 {{< highlight bash >}}
@@ -87,3 +77,31 @@ redis> TDIGEST.BYREVRANK t 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
 15) "1"
 16) "-inf"
 {{< / highlight >}}
+
+## Return information
+
+{{< multitabs id=“tdigest-byrevrank-return-info" 
+    tab1="RESP2" 
+    tab2="RESP3" >}}
+
+One of the following:
+
+* [Array]({{< relref "/develop/reference/protocol-spec#arrays" >}}) of [bulk strings]({{< relref "/develop/reference/protocol-spec#bulk-strings" >}}) as floating-points, populated with value_1, value_2, ..., value_R:
+    * an accurate result when `rank` is `0`, the value of the largest observation.
+    * an accurate result when `rank` is _n_-1, the value of the smallest observation, where _n_ denotes the number of observations added to the sketch.
+    * `inf` when `rank` is equal to _n_ or larger than _n_.
+    * `nan` for all ranks when the given sketch is empty.
+* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: the given key does not exist or is of an incorrect type, rank parsing errors, or an incorrect number of arguments.
+
+-tab-sep-
+
+One of the following:
+
+* [Array]({{< relref "/develop/reference/protocol-spec#arrays" >}}) of [doubles]({{< relref "/develop/reference/protocol-spec#doubles" >}}) as floating-points, populated with value_1, value_2, ..., value_R:
+    * an accurate result when `rank` is `0`, the value of the largest observation.
+    * an accurate result when `rank` is _n_-1, the value of the smallest observation, where _n_ denotes the number of observations added to the sketch.
+    * `inf` when `rank` is equal to _n_ or larger than _n_.
+    * `nan` for all ranks when the given sketch is empty.
+* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: the given key does not exist or is of an incorrect type, rank parsing errors, or an incorrect number of arguments.
+
+{{< /multitabs >}}

content/commands/tdigest.cdf.md

@@ -19,7 +19,7 @@ categories:
 - kubernetes
 - clients
 complexity: O(N) where N is the number of values specified.
-description: Returns, for each input value, an estimation of the fraction (floating-point)
+description: Returns, for each input value, an estimation of the floating-point fraction
   of (observations smaller than the given value + half the observations equal to the
   given value)
 group: tdigest
@@ -28,32 +28,27 @@ linkTitle: TDIGEST.CDF
 module: Bloom
 since: 2.4.0
 stack_path: docs/data-types/probabilistic
-summary: Returns, for each input value, an estimation of the fraction (floating-point)
+summary: Returns, for each input value, an estimation of the floating-point fraction
   of (observations smaller than the given value + half the observations equal to the
   given value)
 syntax_fmt: TDIGEST.CDF key value [value ...]
 syntax_str: value [value ...]
 title: TDIGEST.CDF
 ---
-Returns, for each input value, an estimation of the fraction (floating-point) of (observations smaller than the given value + half the observations equal to the given value).
-
+Returns, for each input value, an estimation of the floating-point fraction of (_observations smaller than the given value_ + _half the observations equal to the given value_).
 Multiple fractions can be retrieved in a single call.
 
 ## Required arguments
 
 <details open><summary><code>key</code></summary>
-is key name for an existing t-digest sketch.
-</details>
 
-<details open><summary><code>value</code></summary>
-is value for which the CDF (Cumulative Distribution Function) should be retrieved.
+is the key name for an existing t-digest sketch.
 </details>
 
-## Return value
-
-[Array reply]({{< relref "/develop/reference/protocol-spec#arrays" >}}) - the command returns an array of floating-points populated with fraction_1, fraction_2, ..., fraction_N. 
+<details open><summary><code>value</code></summary>
 
-All values are 'nan' if the sketch is empty.
+are the values for which the CDF (Cumulative Distribution Function) should be retrieved.
+</details>
 
 ## Examples
 
@@ -71,3 +66,25 @@ redis> TDIGEST.CDF t 0 1 2 3 4 5 6
 6) "0.83333333333333337"
 7) "1"
 {{< / highlight >}}
+
+## Return information
+
+{{< multitabs id=“tdigest-cdf-return-info" 
+    tab1="RESP2" 
+    tab2="RESP3" >}}
+
+One of the following:
+
+* [Array]({{< relref "/develop/reference/protocol-spec#arrays" >}}) of [bulk string replies]({{< relref "/develop/reference/protocol-spec#bulk-strings" >}}) as floating-points, populated with fraction_1, fraction_2, ..., fraction_N.
+All values are `nan` if the given sketch is empty.
+* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: the given key does not exist or is of an incorrect type, value parsing errors, or an incorrect number of arguments.
+
+-tab-sep-
+
+One of the following:
+
+* [Array]({{< relref "/develop/reference/protocol-spec#arrays" >}}) of [doubles]({{< relref "/develop/reference/protocol-spec#bulk-strings" >}})populated with fraction_1, fraction_2, ..., fraction_N.
+All values are `nan` if the given sketch is empty.
+* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: the given key does not exist or is of an incorrect type, value parsing errors, or an incorrect number of arguments.
+
+{{< /multitabs >}}

content/commands/tdigest.create.md

@@ -37,24 +37,40 @@ Allocates memory and initializes a new t-digest sketch.
 ## Required arguments
 
 <details open><summary><code>key</code></summary> 
-is key name for this new t-digest sketch.
+
+is the key name for this new t-digest sketch.
 </details>
 
 ## Optional arguments
 
-<details open><summary><code>COMPRESSION compression</code></summary> 
-
-is a controllable tradeoff between accuracy and memory consumption. 100 is a common value for normal uses. 1000 is more accurate. If no value is passed by default the compression will be 100. For more information on scaling of accuracy versus the compression parameter see [_The t-digest: Efficient estimates of distributions_](https://www.sciencedirect.com/science/article/pii/S2665963820300403).
+<details open><summary><code>COMPRESSION compression</code></summary>
 
+is a controllable tradeoff between accuracy and memory consumption. 100 is a common value for normal uses and also the default if not specified. 1000 is more accurate. For more information on scaling of accuracy versus the compression value see [_The t-digest: Efficient estimates of distributions_](https://www.sciencedirect.com/science/article/pii/S2665963820300403).
 </details>
-  
-## Return value
-
-[Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) - `OK` if executed correctly, or [] otherwise.
 
-## Examples
+## Example
 
 {{< highlight bash >}}
 redis> TDIGEST.CREATE t COMPRESSION 100
 OK
 {{< / highlight >}}
+
+## Return information
+
+{{< multitabs id=“tdigest-create-return-info" 
+    tab1="RESP2" 
+    tab2="RESP3" >}}
+
+One of the following:
+
+* [Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) `OK` if executed correctly.
+* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: incorrect key type or incorrect keyword.
+
+-tab-sep-
+
+One of the following:
+
+* [Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}) `OK` if executed correctly.
+* [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: incorrect key type or incorrect keyword.
+
+{{< /multitabs >}}