From 1c77269abc1a4772c8123470e93e1cd38f316e2f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bj=C3=B6rn-Egil=20Dahlberg?= <egil@erlang.org>
Date: Thu, 19 Mar 2015 11:38:42 +0100
Subject: erl_interface: Document non finite encoding returns

---
 lib/erl_interface/doc/src/ei.xml        | 3 +++
 lib/erl_interface/doc/src/erl_eterm.xml | 6 ++++--
 2 files changed, 7 insertions(+), 2 deletions(-)

(limited to 'lib/erl_interface/doc')

diff --git a/lib/erl_interface/doc/src/ei.xml b/lib/erl_interface/doc/src/ei.xml
index 90495eebd6..32e0e0e2d8 100644
--- a/lib/erl_interface/doc/src/ei.xml
+++ b/lib/erl_interface/doc/src/ei.xml
@@ -202,6 +202,9 @@ typedef enum {
       <desc>
         <p>Encodes a double-precision (64 bit) floating point number in
           the binary format.</p>
+      <p>
+          The function returns <c><![CDATA[-1]]></c> if the floating point number is not finite.
+      </p>
       </desc>
     </func>
     <func>
diff --git a/lib/erl_interface/doc/src/erl_eterm.xml b/lib/erl_interface/doc/src/erl_eterm.xml
index 429f77501c..2152192696 100644
--- a/lib/erl_interface/doc/src/erl_eterm.xml
+++ b/lib/erl_interface/doc/src/erl_eterm.xml
@@ -371,9 +371,11 @@ iohead ::= Binary
         <p><c><![CDATA[f]]></c> is a value to be converted to an Erlang float.</p>
         <p></p>
         <p>The function returns an Erlang float object with the value
-          specified in <c><![CDATA[f]]></c>.</p>
+            specified in <c><![CDATA[f]]></c> or <c><![CDATA[NULL]]></c> if
+            <c><![CDATA[f]]></c> is not finite.
+        </p>
         <p><c><![CDATA[ERL_FLOAT_VALUE(t)]]></c> can be used to retrieve the
-          value from an Erlang float.</p>
+            value from an Erlang float.</p>
       </desc>
     </func>
     <func>
-- 
cgit v1.2.3