From 4a4309327ad7b7c306c2c82fbc88157d4635f123 Mon Sep 17 00:00:00 2001
From: Julian Kent <jkflying@gmail.com>
Date: Thu, 5 Sep 2019 10:12:45 +0200
Subject: [PATCH] better API comment

Co-Authored-By: Julian Oes <julian@oes.ch>
---
 matrix/helper_functions.hpp | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/matrix/helper_functions.hpp b/matrix/helper_functions.hpp
index e13b1f297d..eee74ebeec 100644
--- a/matrix/helper_functions.hpp
+++ b/matrix/helper_functions.hpp
@@ -26,7 +26,7 @@ bool is_finite(Type x) {
  * @param x input possibly outside of the range
  * @param low lower limit of the allowed range
  * @param high upper limit of the allowed range
- * @return wrapped value inside the range
+ * @return wrapped value inside the range, or NAN if value is too far away from range.
  */
 template<typename Type>
 Type wrap(Type x, Type low, Type high) {