summaryrefslogtreecommitdiff
path: root/Doc/c-api/init.rst
diff options
context:
space:
mode:
Diffstat (limited to 'Doc/c-api/init.rst')
-rw-r--r--Doc/c-api/init.rst4
1 files changed, 4 insertions, 0 deletions
diff --git a/Doc/c-api/init.rst b/Doc/c-api/init.rst
index b2baab5efb..d79c12391b 100644
--- a/Doc/c-api/init.rst
+++ b/Doc/c-api/init.rst
@@ -371,6 +371,10 @@ Initialization, Finalization, and Threads
Set the default "home" directory, that is, the location of the standard
Python libraries. The libraries are searched in
:file:`{home}/lib/python{version}` and :file:`{home}/lib/python{version}`.
+ The argument should point to a zero-terminated character string in static
+ storage whose contents will not change for the duration of the program's
+ execution. No code in the Python interpreter will change the contents of
+ this storage.
.. cfunction:: w_char* Py_GetPythonHome()