File 0313-Document-that-NaN-Inf-Inf-are-not-valid-Er... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 0313-Document-that-NaN-Inf-Inf-are-not-valid-Erlang-terms.patch of Package erlang

From b91abf7baac1f49caf507c1f32cd8d1f7e112077 Mon Sep 17 00:00:00 2001
From: Robin Morisset <rmorisset@meta.com>
Date: Fri, 26 May 2023 02:06:42 -0700
Subject: [PATCH] Document that NaN, +Inf, -Inf are not valid Erlang terms.

The only documentation I managed to find about those values in Erlang is an 11 years-old mailing list message by Sverker:
http://erlang.org/pipermail/erlang-questions/2012-February/064728.html.

This commit just copies that information into the official documentation.
---
 system/doc/reference_manual/data_types.xml | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/system/doc/reference_manual/data_types.xml b/system/doc/reference_manual/data_types.xml
index 6cbf864a79..4b58c6a5ca 100644
--- a/system/doc/reference_manual/data_types.xml
+++ b/system/doc/reference_manual/data_types.xml
@@ -132,6 +132,9 @@ exactly as floats.</p>
         then you should use a library that handles that or work in cents instead of euros so
         that you do not need decimal fractions.
       </p>
+      <p>Please also note that Erlang's floats do not exactly match IEEE 754 floats, in that neither Inf nor NaN are supported in Erlang.
+        Any operation that would result in NaN, +Inf, or -Inf, will instead raise a <c>badarith</c> exception.
+      </p>
     </section>
   </section>
 
@@ -568,4 +571,3 @@ hello
 7.0</pre>
   </section>
 </chapter>
-
-- 
2.35.3

Places

File 0313-Document-that-NaN-Inf-Inf-are-not-valid-Erlang-terms.patch of Package erlang

Places