Issue 6288: Update contextlib.nested() docstring to reflect new documentation

0d8b4e33 · Nick Coghlan · 94819cf4 · 0d8b4e33
Kaydet (Commit) 0d8b4e33 authored Haz 23, 2009 tarafından Nick Coghlan
Hide whitespace changes
Inline Side-by-side

Showing with 8 additions and 10 deletions

contextlib.py Lib/contextlib.py +8 -10

No files found.
--- a/Lib/contextlib.py
+++ b/Lib/contextlib.py
@@ -87,19 +87,17 @@ def contextmanager(func):
 @contextmanager
 def nested(*managers):
-    """Support multiple context managers in a single with-statement.
+    """Combine multiple context managers into a single nested context manager.
-    Code like this:
+   This function has been deprecated in favour of the multiple manager form
+   of the :keyword:`with` statement.
-        with nested(A, B, C) as (X, Y, Z):
-            <body>
-    is equivalent to this:
+   The one advantage of this function over the multiple manager form of the
+   :keyword:`with` statement is that argument unpacking allows it to be
+   used with a variable number of context managers as follows:
-        with A as X:
+      with nested(*managers):
-            with B as Y:
+          do_something()
-                with C as Z:
-                    <body>
    """
    warn("With-statements now directly support multiple context managers",