From 16d3436746250573fc976c043b23c354e6ba3ce6 Mon Sep 17 00:00:00 2001
From: Hans Bolinder <hasse@erlang.org>
Date: Mon, 21 May 2018 15:17:09 +0200
Subject: stdlib: Document details of fwrite/3 option chars_limit

---
 lib/stdlib/doc/src/io_lib.xml | 34 +++++++++++++++++++---------------
 1 file changed, 19 insertions(+), 15 deletions(-)

(limited to 'lib/stdlib')

diff --git a/lib/stdlib/doc/src/io_lib.xml b/lib/stdlib/doc/src/io_lib.xml
index 4a2b425e8e..a3df2897ac 100644
--- a/lib/stdlib/doc/src/io_lib.xml
+++ b/lib/stdlib/doc/src/io_lib.xml
@@ -163,16 +163,20 @@
         <p>Returns a character list that represents <c><anno>Data</anno></c>
           formatted in accordance with <c><anno>Format</anno></c> in
           the same way as
-	  <seealso marker="#fwrite/2"><c>fwrite/2</c></seealso> and
-	  <seealso marker="#format/2"><c>format/2</c></seealso>,
-	  but takes an extra argument, a list of options.</p>
-	  <p>Available options:</p>
-	  <taglist>
-	    <tag><c><anno>CharsLimit</anno></c></tag>
-	    <item>
-	      <p>A soft limit on the number of characters returned.</p>
-	    </item>
-	  </taglist>
+          <seealso marker="#fwrite/2"><c>fwrite/2</c></seealso> and
+          <seealso marker="#format/2"><c>format/2</c></seealso>,
+          but takes an extra argument, a list of options.</p>
+          <p>Valid option:</p>
+          <taglist>
+            <tag><c>{chars_limit, <anno>CharsLimit</anno>}</c></tag>
+            <item>
+              <p>A soft limit on the number of characters returned.
+                When the number of characters is reached, remaining
+                structures are replaced by "<c>...</c>".
+                <c><anno>CharsLimit</anno></c> defaults to -1, which
+		means no limit on the number of characters returned.</p>
+            </item>
+          </taglist>
       </desc>
     </func>
 
@@ -390,11 +394,11 @@
           everything below this level is replaced by "<c>...</c>".
           <c><anno>Depth</anno></c> defaults to -1, which means
           no limitation. Option <c><anno>CharsLimit</anno></c> puts a
-	  soft limit on the number of characters returned. When the
-	  number of characters is reached, remaining structures are
-	  replaced by "<c>...</c>". <c><anno>CharsLimit</anno></c>
-	  defaults to -1, which means no limit on the number of
-	  characters returned.</p>
+          soft limit on the number of characters returned. When the
+          number of characters is reached, remaining structures are
+          replaced by "<c>...</c>". <c><anno>CharsLimit</anno></c>
+          defaults to -1, which means no limit on the number of
+          characters returned.</p>
         <p><em>Example:</em></p>
         <pre>
 1> <input>lists:flatten(io_lib:write({1,[2],[3],[4,5],6,7,8,9})).</input>
-- 
cgit v1.2.3