svn+ssh://pythondev@svn.python.org/python/trunk
........
r73518 | nick.coghlan | 2009-06-23 20:19:30 +1000 (Tue, 23 Jun 2009) | 1 line
Issue 6288: Update contextlib.nested() docstring to reflect new documentation
........
r73519 | nick.coghlan | 2009-06-23 20:51:02 +1000 (Tue, 23 Jun 2009) | 1 line
Remove markup from docstring
........
@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:
-
- with nested(A, B, C) as (X, Y, Z):
- <body>
+ This function has been deprecated in favour of the multiple manager form
+ of the with statement.
- is equivalent to this:
+ The one advantage of this function over the multiple manager form of the
+ 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 B as Y:
- with C as Z:
- <body>
+ with nested(*managers):
+ do_something()
"""
warn("With-statements now directly support multiple context managers",