File 1020-erlang-module-doc-list_to_integer-and-bina... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 1020-erlang-module-doc-list_to_integer-and-binary_to_inte.patch of Package erlang

From 96b4a0c6d682d9a28f7583e20798ee4353362f4a Mon Sep 17 00:00:00 2001
From: Kjell Winblad <kjellwinblad@gmail.com>
Date: Tue, 1 Sep 2020 11:20:15 +0200
Subject: [PATCH 10/39] erlang module doc: list_to_integer and
 binary_to_integer

Add information about accepted string formats
---
 erts/doc/src/erlang.xml | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)

diff --git a/erts/doc/src/erlang.xml b/erts/doc/src/erlang.xml
index 99ba602126..8f286c87e6 100644
--- a/erts/doc/src/erlang.xml
+++ b/erts/doc/src/erlang.xml
@@ -574,6 +574,9 @@ Z = erlang:adler32_combine(X,Y,iolist_size(Data2)).</code>
         <pre>
 > <input>binary_to_integer(&lt;&lt;"123"&gt;&gt;).</input>
 123</pre>
+        <p><c>binary_to_integer/1</c> accepts the same string formats
+        as <seealso
+        marker="#list_to_integer/1"><c>list_to_integer/1</c></seealso>.</p>
         <p>Failure: <c>badarg</c> if <c><anno>Binary</anno></c> contains a bad
           representation of an integer.</p>
       </desc>
@@ -589,6 +592,9 @@ Z = erlang:adler32_combine(X,Y,iolist_size(Data2)).</code>
         <pre>
 > <input>binary_to_integer(&lt;&lt;"3FF"&gt;&gt;, 16).</input>
 1023</pre>
+        <p><c>binary_to_integer/2</c> accepts the same string formats
+        as <seealso
+        marker="#list_to_integer/2"><c>list_to_integer/2</c></seealso>.</p>
         <p>Failure: <c>badarg</c> if <c><anno>Binary</anno></c> contains a bad
           representation of an integer.</p>
       </desc>
@@ -2869,6 +2875,17 @@ false</code>
         <pre>
 > <input>list_to_integer("123").</input>
 123</pre>
+        <pre>
+> <input>list_to_integer("-123").</input>
+-123</pre>
+        <pre>
+> <input>list_to_integer("+123234982304982309482093833234234").</input>
+123234982304982309482093833234234</pre>
+        <p><c><anno>String</anno></c> must contain at least one digit
+        character and can have an optional prefix consisting of a
+        single "<c>+</c>" or "<c>-</c>" character (that is,
+        <c><anno>String</anno></c> must match the regular
+        expression <c>"^[+-]?[0-9]+$"</c>).</p>
         <p>Failure: <c>badarg</c> if <c><anno>String</anno></c> contains a bad
           representation of an integer.</p>
       </desc>
@@ -2884,6 +2901,21 @@ false</code>
         <pre>
 > <input>list_to_integer("3FF", 16).</input>
 1023</pre>
+        <pre>
+> <input>list_to_integer("+3FF", 16).</input>
+1023</pre>
+        <pre>
+> <input>list_to_integer("3ff", 16).</input>
+1023</pre>
+        <pre>
+> <input>list_to_integer("3fF", 16).</input>
+1023</pre>
+        <pre>
+> <input>list_to_integer("-3FF", 16).</input>
+-1023</pre>
+        <p>For example, when <c><anno>Base</anno></c> is 16,
+        <c><anno>String</anno></c> must match the regular
+        expression <c>"^[+-]?([0-9]|[A-F]|[a-f])+$"</c>.</p>
         <p>Failure: <c>badarg</c> if <c><anno>String</anno></c> contains a bad
           representation of an integer.</p>
       </desc>
-- 
2.26.2

Places

File 1020-erlang-module-doc-list_to_integer-and-binary_to_inte.patch of Package erlang

Places