diff options
author | Guilherme Andrade <[email protected]> | 2017-03-23 00:09:58 +0000 |
---|---|---|
committer | Guilherme Andrade <[email protected]> | 2017-03-23 00:09:58 +0000 |
commit | 25648cad32b782cff5b513cb1e1a72d2f9f4ada7 (patch) | |
tree | dc846469c63a66c2824f8f5d292a3f25e87db3c4 | |
parent | 7cb2ca89f96d9724267b46d2f1eb52a2cbe7c06f (diff) | |
download | otp-25648cad32b782cff5b513cb1e1a72d2f9f4ada7.tar.gz otp-25648cad32b782cff5b513cb1e1a72d2f9f4ada7.tar.bz2 otp-25648cad32b782cff5b513cb1e1a72d2f9f4ada7.zip |
ets: Polish select_replace/2 documentation
-rw-r--r-- | lib/stdlib/doc/src/ets.xml | 16 |
1 files changed, 7 insertions, 9 deletions
diff --git a/lib/stdlib/doc/src/ets.xml b/lib/stdlib/doc/src/ets.xml index 29d22ffae5..d1ec176f81 100644 --- a/lib/stdlib/doc/src/ets.xml +++ b/lib/stdlib/doc/src/ets.xml @@ -1494,19 +1494,17 @@ is_integer(X), is_integer(Y), X + Y < 4711]]></code> <name name="select_replace" arity="2"/> <fsummary>Match and replace objects atomically in an ETS table</fsummary> <desc> - <warning> - <p>For the moment, due to performance and semantic constraints, - tables of type <c>bag</c> are not yet supported.</p> - </warning> <p>Matches the objects in the table <c><anno>Tab</anno></c> using a - <seealso marker="#match_spec">match specification</seealso>. If the + <seealso marker="#match_spec">match specification</seealso>. If an object is matched, the existing object is replaced with - the match specificatoin result.</p> + the match specification result, which <em>must</em> retain + the original key or the operation will fail with <c>badarg</c>.</p> + <p>For the moment, due to performance and semantic constraints, + tables of type <c>bag</c> are not yet supported.</p> <p>The function returns the total number of replaced objects.</p> <note> - <p>If there's a risk a match specification might return - a tuple with a different key, the whole operation will fail - with <c>badarg</c>.</p> + <p>The match/replacement operation atomicity scope is limited + to each individual object.</p> </note> </desc> </func> |