]> granicus.if.org Git - python/commitdiff
Fix description for Py_GetPath(); it sounded like it always returned sys.path.
authorGeorg Brandl <georg@python.org>
Thu, 7 Jan 2010 20:54:45 +0000 (20:54 +0000)
committerGeorg Brandl <georg@python.org>
Thu, 7 Jan 2010 20:54:45 +0000 (20:54 +0000)
Doc/c-api/init.rst

index bc5eb43fde3b805b99c0f37248acfb8aaffdb9b4..b81c4df904510a5666d3e515269a6f5f4b7c0c4b 100644 (file)
@@ -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