summaryrefslogtreecommitdiffstats
path: root/Doc/c-api
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2011-05-21 15:35:33 (GMT)
committerGeorg Brandl <georg@python.org>2011-05-21 15:35:33 (GMT)
commit9c1928f0a90d687db7a45503ae8a23a38f2d59bb (patch)
tree938ce184fd700ed4bc33efce1f2d372cdcf5c526 /Doc/c-api
parent619323c68fe3b701fb3e50ee382ceec32f72c4fa (diff)
parent41972316f589eb25dfe605f8bcaab18e285c0ee1 (diff)
downloadcpython-9c1928f0a90d687db7a45503ae8a23a38f2d59bb.zip
cpython-9c1928f0a90d687db7a45503ae8a23a38f2d59bb.tar.gz
cpython-9c1928f0a90d687db7a45503ae8a23a38f2d59bb.tar.bz2
Merge release branch after 3.2.1rc1.
Diffstat (limited to 'Doc/c-api')
-rw-r--r--Doc/c-api/veryhigh.rst20
1 files changed, 9 insertions, 11 deletions
diff --git a/Doc/c-api/veryhigh.rst b/Doc/c-api/veryhigh.rst
index 8bece6d..41cdd6b 100644
--- a/Doc/c-api/veryhigh.rst
+++ b/Doc/c-api/veryhigh.rst
@@ -27,17 +27,15 @@ the same library that the Python runtime is using.
.. c:function:: int Py_Main(int argc, wchar_t **argv)
- The main program for the standard interpreter. This is made
- available for programs which embed Python. The *argc* and *argv*
- parameters should be prepared exactly as those which are passed to
- a C program's :c:func:`main` function (converted to wchar_t
- according to the user's locale). It is important to note that the
- argument list may be modified (but the contents of the strings
- pointed to by the argument list are not). The return value will be
- ```0``` if the interpreter exits normally (ie, without an
- exception), ``1`` if the interpreter exits due to an exception, or
- ``2`` if the parameter list does not represent a valid Python
- command line.
+ The main program for the standard interpreter. This is made available for
+ programs which embed Python. The *argc* and *argv* parameters should be
+ prepared exactly as those which are passed to a C program's :c:func:`main`
+ function (converted to wchar_t according to the user's locale). It is
+ important to note that the argument list may be modified (but the contents of
+ the strings pointed to by the argument list are not). The return value will
+ be ``0`` if the interpreter exits normally (i.e., without an exception),
+ ``1`` if the interpreter exits due to an exception, or ``2`` if the parameter
+ list does not represent a valid Python command line.
Note that if an otherwise unhandled :exc:`SystemExit` is raised, this
function will not return ``1``, but exit the process, as long as