From ddb8dd58b6e08cdc375621c33d3712eee506100d Mon Sep 17 00:00:00 2001
From: Hans Bolinder <hasse@erlang.org>
Date: Fri, 10 Apr 2015 11:59:44 +0200
Subject: stdlib: Correct orddict(3)

fold() and map() handle elements in a well-defined order.

Thanks to Rabbe Fogelholm for pointing out the bug.
---
 lib/stdlib/doc/src/orddict.xml |  8 +++-----
 lib/stdlib/doc/src/sets.xml    | 22 ++++++++++++----------
 2 files changed, 15 insertions(+), 15 deletions(-)

(limited to 'lib')

diff --git a/lib/stdlib/doc/src/orddict.xml b/lib/stdlib/doc/src/orddict.xml
index 6d1702bc59..ec1e43f29c 100644
--- a/lib/stdlib/doc/src/orddict.xml
+++ b/lib/stdlib/doc/src/orddict.xml
@@ -4,7 +4,7 @@
 <erlref>
   <header>
     <copyright>
-      <year>2000</year><year>2013</year>
+      <year>2000</year><year>2015</year>
       <holder>Ericsson AB. All Rights Reserved.</holder>
     </copyright>
     <legalnotice>
@@ -125,8 +125,7 @@
           <c><anno>Orddict</anno></c> together with an extra argument <c>Acc</c>
           (short for accumulator). <c><anno>Fun</anno></c> must return a new
           accumulator which is passed to the next call. <c><anno>Acc0</anno></c> is
-          returned if the list is empty. The evaluation order is
-          undefined.</p>
+          returned if the list is empty.</p>
       </desc>
     </func>
     <func>
@@ -150,8 +149,7 @@
       <fsummary>Map a function over a dictionary</fsummary>
       <desc>
         <p><c>map</c> calls <c><anno>Fun</anno></c> on successive keys and values
-          of <c><anno>Orddict1</anno></c> to return a new value for each key.
-          The evaluation order is undefined.</p>
+          of <c><anno>Orddict1</anno></c> to return a new value for each key.</p>
       </desc>
     </func>
     <func>
diff --git a/lib/stdlib/doc/src/sets.xml b/lib/stdlib/doc/src/sets.xml
index c5b8dce4b7..4a31648f8f 100644
--- a/lib/stdlib/doc/src/sets.xml
+++ b/lib/stdlib/doc/src/sets.xml
@@ -4,7 +4,7 @@
 <erlref>
   <header>
     <copyright>
-      <year>2000</year><year>2014</year>
+      <year>2000</year><year>2015</year>
       <holder>Ericsson AB. All Rights Reserved.</holder>
     </copyright>
     <legalnotice>
@@ -65,7 +65,7 @@
     </func>
     <func>
       <name name="is_set" arity="1"/>
-      <fsummary>Test for an <c>Set</c></fsummary>
+      <fsummary>Test for a <c>Set</c></fsummary>
       <desc>
         <p>Returns <c>true</c> if <c><anno>Set</anno></c> is a set of
           elements, otherwise <c>false</c>.</p>
@@ -80,21 +80,22 @@
     </func>
     <func>
       <name name="to_list" arity="1"/>
-      <fsummary>Convert an <c>Set</c>into a list</fsummary>
+      <fsummary>Convert a <c>Set</c>into a list</fsummary>
       <desc>
-        <p>Returns the elements of <c><anno>Set</anno></c> as a list.</p>
+        <p>Returns the elements of <c><anno>Set</anno></c> as a list.
+          The order of the returned elements is undefined.</p>
       </desc>
     </func>
     <func>
       <name name="from_list" arity="1"/>
-      <fsummary>Convert a list into an <c>Set</c></fsummary>
+      <fsummary>Convert a list into a <c>Set</c></fsummary>
       <desc>
-        <p>Returns an set of the elements in <c><anno>List</anno></c>.</p>
+        <p>Returns a set of the elements in <c><anno>List</anno></c>.</p>
       </desc>
     </func>
     <func>
       <name name="is_element" arity="2"/>
-      <fsummary>Test for membership of an <c>Set</c></fsummary>
+      <fsummary>Test for membership of a <c>Set</c></fsummary>
       <desc>
         <p>Returns <c>true</c> if <c><anno>Element</anno></c> is an element of
           <c><anno>Set</anno></c>, otherwise <c>false</c>.</p>
@@ -102,7 +103,7 @@
     </func>
     <func>
       <name name="add_element" arity="2"/>
-      <fsummary>Add an element to an <c>Set</c></fsummary>
+      <fsummary>Add an element to a <c>Set</c></fsummary>
       <desc>
         <p>Returns a new set formed from <c><anno>Set1</anno></c> with
           <c><anno>Element</anno></c> inserted.</p>
@@ -110,7 +111,7 @@
     </func>
     <func>
       <name name="del_element" arity="2"/>
-      <fsummary>Remove an element from an <c>Set</c></fsummary>
+      <fsummary>Remove an element from a <c>Set</c></fsummary>
       <desc>
         <p>Returns <c><anno>Set1</anno></c>, but with <c><anno>Element</anno></c> removed.</p>
       </desc>
@@ -175,7 +176,8 @@
       <fsummary>Fold over set elements</fsummary>
       <desc>
         <p>Fold <c><anno>Function</anno></c> over every element in <c><anno>Set</anno></c>
-          returning the final value of the accumulator.</p>
+          returning the final value of the accumulator.
+          The evaluation order is undefined.</p>
       </desc>
     </func>
     <func>
-- 
cgit v1.2.3