update api docs to warn about isNegative pitfall

sunchuanstc · May 24, 2020 · 39991b8 · 39991b8
1 parent 5a6e138
commit 39991b8
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/doc/API.html b/doc/API.html
@@ -1659,7 +1659,15 @@ <h5 id="isNeg">isNegative<code class='inset'>.isNeg() <i>&rArr; boolean</i></cod
 y.isNeg                                  // false</pre>
     <p>Note: <code>n &lt; 0</code> can be used if <code>n &lt;= -Number.MIN_VALUE</code>.</p>
 
+    <p>Also note that signed zeroes are implemented, following the IEEE Standard
+      for Floating-Point Arithmetic (IEEE 754).</p>
 
+    <pre>
+Decimal(0).valueOf()                 // '0'
+Decimal(0).isNegative()              // false
+Decimal(0).negated().valueOf()       // '-0'
+Decimal(0).negated().isNegative()    // true
+    </pre>
 
      <h5 id="isPos">isPositive<code class='inset'>.isPos() <i>&rArr; boolean</i></code></h5>
     <p>