summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2010-01-07 20:54:45 (GMT)
committerGeorg Brandl <georg@python.org>2010-01-07 20:54:45 (GMT)
commit54fd8ae0a38018ac122aefdda68bdea341d0de20 (patch)
tree49d7f83b980b8be943b3cebe55daf0141d8a6990
parent54584188cd332f99812c7c044c5dffec551b7341 (diff)
downloadcpython-54fd8ae0a38018ac122aefdda68bdea341d0de20.zip
cpython-54fd8ae0a38018ac122aefdda68bdea341d0de20.tar.gz
cpython-54fd8ae0a38018ac122aefdda68bdea341d0de20.tar.bz2
Fix description for Py_GetPath(); it sounded like it always returned sys.path.
-rw-r--r--Doc/c-api/init.rst17
1 files changed, 9 insertions, 8 deletions
diff --git a/Doc/c-api/init.rst b/Doc/c-api/init.rst
index bc5eb43..b81c4df 100644
--- a/Doc/c-api/init.rst
+++ b/Doc/c-api/init.rst
@@ -257,14 +257,15 @@ Initialization, Finalization, and Threads
triple: module; search; path
single: path (in module sys)
- Return the default module search path; this is computed from the program name
- (set by :cfunc:`Py_SetProgramName` above) and some environment variables. The
- returned string consists of a series of directory names separated by a platform
- dependent delimiter character. The delimiter character is ``':'`` on Unix and
- Mac OS X, ``';'`` on Windows. The returned string points into static storage;
- the caller should not modify its value. The value is available to Python code
- as the list ``sys.path``, which may be modified to change the future search path
- for loaded modules.
+ Return the default module search path; this is computed from the program name
+ (set by :cfunc:`Py_SetProgramName` above) and some environment variables.
+ The returned string consists of a series of directory names separated by a
+ platform dependent delimiter character. The delimiter character is ``':'``
+ on Unix and Mac OS X, ``';'`` on Windows. The returned string points into
+ static storage; the caller should not modify its value. The list
+ :data:`sys.path` is initialized with this value on interpreter startup; it
+ can be (and usually is) modified later to change the search path for loading
+ modules.
.. XXX should give the exact rules