Fix description for Py_GetPath(); it sounded like it always returned sys.path.

This commit is contained in:
Georg Brandl 2010-01-07 20:54:45 +00:00
parent 54584188cd
commit 54fd8ae0a3

View file

@ -258,13 +258,14 @@ Initialization, Finalization, and Threads
single: path (in module sys) single: path (in module sys)
Return the default module search path; this is computed from the program name Return the default module search path; this is computed from the program name
(set by :cfunc:`Py_SetProgramName` above) and some environment variables. The (set by :cfunc:`Py_SetProgramName` above) and some environment variables.
returned string consists of a series of directory names separated by a platform The returned string consists of a series of directory names separated by a
dependent delimiter character. The delimiter character is ``':'`` on Unix and platform dependent delimiter character. The delimiter character is ``':'``
Mac OS X, ``';'`` on Windows. The returned string points into static storage; on Unix and Mac OS X, ``';'`` on Windows. The returned string points into
the caller should not modify its value. The value is available to Python code static storage; the caller should not modify its value. The list
as the list ``sys.path``, which may be modified to change the future search path :data:`sys.path` is initialized with this value on interpreter startup; it
for loaded modules. can be (and usually is) modified later to change the search path for loading
modules.
.. XXX should give the exact rules .. XXX should give the exact rules