utils: Add clarification to util.isFloat() jsdoc

2017-05-11 14:37:18 -07:00 · 2017-05-11 14:37:18 -07:00 · 3e06a244dd
commit 3e06a244dd
parent 21dc8b4af0
1 changed files with 5 additions and 0 deletions
--- a/lib/utils/util.js
+++ b/lib/utils/util.js
@ -392,6 +392,11 @@ util.isHex256 = function isHex256(hash) {

 /**
 * Test whether a string qualifies as a float.
+ *
+ * This is stricter than checking if the result of parseFloat() is NaN
+ * as, e.g. parseFloat successfully parses the string '1.2.3' as 1.2, and
+ * we also check that the value is a string.
+ *
 * @param {String?} value
 * @returns {Boolean}
 */