File 0811-Updated-doc-for-maps-foreach-2.-Added-example-for-ma.patch of Package erlang
From 1a2083e488658b8c7193b6d796ffca719e683be8 Mon Sep 17 00:00:00 2001
From: iri <ram3a12@gmail.com>
Date: Tue, 31 Dec 2024 15:25:34 +0300
Subject: [PATCH] Updated doc for maps:foreach/2. Added example for
maps:foreach/2.
---
lib/stdlib/src/maps.erl | 16 +++++++++++++++-
1 file changed, 15 insertions(+), 1 deletion(-)
diff --git a/lib/stdlib/doc/src/maps.xml b/lib/stdlib/doc/src/maps.xml
index f48a5673af..c9ac59dec3 100644
--- a/lib/stdlib/doc/src/maps.xml
+++ b/lib/stdlib/doc/src/maps.xml
@@ -174,13 +174,24 @@
<name name="foreach" arity="2" since="OTP 24.0"/>
<fsummary>Apply a function to each element of a map.</fsummary>
<desc>
- <p>Calls <c>fun F(Key, Value)</c> for every <c><anno>Key</anno></c>
+ <p>Calls <c>fun Fun(Key, Value)</c> for every <c><anno>Key</anno></c>
to value <c><anno>Value</anno></c> association in
<c><anno>MapOrIter</anno></c> in any order.</p>
<p>The call fails with a <c>{badmap,Map}</c> exception if
<c><anno>MapOrIter</anno></c> is not a map or valid iterator,
or with <c>badarg</c> if <c><anno>Fun</anno></c> is not a
function of arity 2.</p>
+ <p><em>Example:</em></p>
+ <code type="none">
+> Fun = fun(K,V) -> io:format("~p:~p~n",[K,V]) end.
+#Fun<erl_eval.41.18682967>
+> Map = #{"x" => 10, "y" => 20, "z" => 30}.
+#{"x" => 10,"y" => 20,"z" => 30}
+> maps:foreach(Fun,Map).
+"x":10
+"y":20
+"z":30
+ok</code>
</desc>
</func>
--
2.43.0