From: Georg Brandl <georg@python.org>
Date: Mon, 26 Dec 2005 23:56:08 +0000 (+0000)
Subject: Bug #1389673: document correct return value of set methods (backport)
X-Git-Tag: v2.4.3c1~172
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=19d245d2e2c9a0fbb89f98dd918ab5d26b6e683c;p=thirdparty%2FPython%2Fcpython.git

Bug #1389673: document correct return value of set methods (backport)
---

diff --git a/Doc/lib/libstdtypes.tex b/Doc/lib/libstdtypes.tex
index fa3bd5f72d8f..cc31e86a691a 100644
--- a/Doc/lib/libstdtypes.tex
+++ b/Doc/lib/libstdtypes.tex
@@ -1261,17 +1261,17 @@ that do not apply to immutable instances of \class{frozenset}:
 \begin{tableiii}{c|c|l}{code}{Operation}{Equivalent}{Result}
   \lineiii{\var{s}.update(\var{t})}
          {\var{s} |= \var{t}}
-         {return set \var{s} with elements added from \var{t}}
+         {update set \var{s}, adding elements from \var{t}}
   \lineiii{\var{s}.intersection_update(\var{t})}
          {\var{s} \&= \var{t}}
-         {return set \var{s} keeping only elements also found in \var{t}}
+         {update set \var{s}, keeping only elements found in both \var{s} and \var{t}}
   \lineiii{\var{s}.difference_update(\var{t})}
          {\var{s} -= \var{t}}
-         {return set \var{s} after removing elements found in \var{t}}
+         {update set \var{s}, removing elements found in \var{t}}
   \lineiii{\var{s}.symmetric_difference_update(\var{t})}
          {\var{s} \textasciicircum= \var{t}}
-         {return set \var{s} with elements from \var{s} or \var{t}
-          but not both}
+         {update set \var{s}, keeping only elements found in either \var{s} or \var{t}
+          but not in both}
 
   \hline
   \lineiii{\var{s}.add(\var{x})}{}