summaryrefslogtreecommitdiffstats
path: root/Lib/venv
diff options
context:
space:
mode:
authorVinay Sajip <vinay_sajip@yahoo.co.uk>2012-11-14 11:18:35 (GMT)
committerVinay Sajip <vinay_sajip@yahoo.co.uk>2012-11-14 11:18:35 (GMT)
commit87ed599b8a4afffbcb63677b19865b06e05032cf (patch)
tree8db262498bdf73fbef8270da8973087b71948099 /Lib/venv
parent000bd4254fa23a9ea3dee356ac747f48c3b0e74f (diff)
downloadcpython-87ed599b8a4afffbcb63677b19865b06e05032cf.zip
cpython-87ed599b8a4afffbcb63677b19865b06e05032cf.tar.gz
cpython-87ed599b8a4afffbcb63677b19865b06e05032cf.tar.bz2
Issue #16378: Updated docstrings to reflect the defaults present in the code.
Diffstat (limited to 'Lib/venv')
-rw-r--r--Lib/venv/__init__.py11
1 files changed, 7 insertions, 4 deletions
diff --git a/Lib/venv/__init__.py b/Lib/venv/__init__.py
index 3c0d7af..3920747 100644
--- a/Lib/venv/__init__.py
+++ b/Lib/venv/__init__.py
@@ -54,9 +54,11 @@ class EnvBuilder:
behaviour when called upon to create a virtual environment.
By default, the builder makes the system (global) site-packages dir
- available to the created environment.
+ *un*available to the created environment.
- By default, the creation process uses symlinks wherever possible.
+ If invoked using the Python -m option, the default is to use copying
+ on Windows platforms but symlinks elsewhere. If instantiated some
+ other way, the default is to *not* use symlinks.
:param system_site_packages: If True, the system (global) site-packages
dir is available to created environments.
@@ -322,8 +324,9 @@ def create(env_dir, system_site_packages=False, clear=False, symlinks=False):
"""
Create a virtual environment in a directory.
- By default, makes the system (global) site-packages dir available to
- the created environment.
+ By default, makes the system (global) site-packages dir *un*available to
+ the created environment, and uses copying rather than symlinking for files
+ obtained from the source Python installation.
:param env_dir: The target directory to create an environment in.
:param system_site_packages: If True, the system (global) site-packages