Add docstring, expanding test coverage.

jaraco · Oct 23, 2023 · 4057ccb · 4057ccb
1 parent 6a4b682
commit 4057ccb
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/jaraco/envs.py b/jaraco/envs.py
@@ -8,6 +8,19 @@
 
 
 class VirtualEnv:
+    """
+    >>> mp = getfixture('monkeypatch')
+    >>> root = getfixture('tmp_path')
+    >>> mp.setenv('SERVICES_ROOT', str(root))
+
+    Subclass VirtualEnv and supply name and req:
+
+    >>> class MyVirtualEnv(VirtualEnv):
+    ...     name = '.venv'
+    ...     req = 'example'
+    >>> env = MyVirtualEnv().create()
+    """
+
     root = Path(os.environ.get('SERVICES_ROOT', '.cache/services'))
     clean_opts = ["--no-setuptools", "--no-pip", "--no-wheel"]