Add docstrings to TempDir class

jaraco · May 24, 2020 · 71190e6 · 71190e6
1 parent ed6533e
commit 71190e6
Showing 1 changed file with 8 additions and 4 deletions.
diff --git a/path/__init__.py b/path/__init__.py
@@ -1610,12 +1610,16 @@ class TempDir(Path):
     constructed with the same parameters that you can use
     as a context manager.
 
-    Example::
+    For example:
 
-        with TempDir() as d:
-            # do stuff with the Path object "d"
+    >>> with TempDir() as d:
+    ...     d.isdir() and isinstance(d, Path)
+    True
+
+    The directory is deleted automatically.
 
-        # here the directory is deleted automatically
+    >>> d.isdir()
+    False
 
     .. seealso:: :func:`tempfile.mkdtemp`
     """