[Python-checkins] cpython (3.3): Issue #16378: Updated docstrings to reflect the defaults present in the code.

Wed Nov 14 12:19:59 CET 2012

http://hg.python.org/cpython/rev/afb476dc202f
changeset: 80424:afb476dc202f
branch: 3.3
parent: 80419:21cc413eb23c
user: Vinay Sajip <vinay_sajip at yahoo.co.uk>
date: Wed Nov 14 11:18:35 2012 +0000
summary:
 Issue #16378: Updated docstrings to reflect the defaults present in the code.
files:
 Lib/venv/__init__.py | 11 +++++++----
 1 files changed, 7 insertions(+), 4 deletions(-)

diff --git a/Lib/venv/__init__.py b/Lib/venv/__init__.py
--- a/Lib/venv/__init__.py
+++ b/Lib/venv/__init__.py
@@ -54,9 +54,11 @@
 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 @@
 """
 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
-- 
Repository URL: http://hg.python.org/cpython
