felipecrv commented on code in PR #44630:
URL: https://github.com/apache/arrow/pull/44630#discussion_r1871492470
##########
cpp/src/arrow/compute/kernels/scalar_arithmetic.cc:
##########
@@ -1221,6 +1317,16 @@ const FunctionDoc atan2_doc{"Compute the inverse tangent
of y/x",
("The return value is in the range [-pi, pi]."),
{"y", "x"}};
+const FunctionDoc atanh_doc{"Compute the inverse hyperbolic tangent",
+ ("NaN is returned for invalid input values;\n"
+ "to raise an error instead, see
\"atanh_checked\"."),
+ {"x"}};
+
+const FunctionDoc atanh_checked_doc{"Compute the inverse hyperbolic tangent",
+ ("Invalid input values raise an error;\n"
+ "to return NaN instead, see \"atanh\"."),
+ {"x"}};
Review Comment:
```suggestion
const FunctionDoc atanh_checked_doc{"Compute the inverse hyperbolic tangent",
("Input values outside the (-1.0, 1.0)
range raise an error;\n"
"to return NaN, -Inf, and Inf instead,
see \"atanh\"."),
{"x"}};
```
--
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.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
