rok commented on a change in pull request #10476:
URL: https://github.com/apache/arrow/pull/10476#discussion_r651772086
##########
File path: docs/source/cpp/compute.rst
##########
@@ -213,18 +213,23 @@ Aggregations
Notes:
-* \(1) Output is a ``{"min": input type, "max": input type}`` Struct.
+* \(1) If null values are taken into account by setting ScalarAggregateOptions
+ parameter skip_nulls = false then `Kleene logic`_ logic is applied.
-* \(2) Output is an array of ``{"mode": input type, "count": Int64}`` Struct.
+* \(2) Output is a ``{"min": input type, "max": input type}`` Struct.
+
+* \(3) Output is an array of ``{"mode": input type, "count": Int64}`` Struct.
It contains the *N* most common elements in the input, in descending
order, where *N* is given in :member:`ModeOptions::n`.
If two values have the same count, the smallest one comes first.
Note that the output can have less than *N* elements if the input has
less than *N* distinct values.
-* \(3) Output is Float64 or input type, depending on QuantileOptions.
+* \(4) Output is Float64 or input type, depending on QuantileOptions.
+
+* \(5) Output is Int64, UInt64 or Float64, depending on the input type.
-* \(4) Output is Int64, UInt64 or Float64, depending on the input type.
+.. _Kleene logic:
https://en.wikipedia.org/wiki/Three-valued_logic#Kleene_and_Priest_logics
Review comment:
Removed. I was not sure how scopes in rst work :).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
