[Python-checkins] bpo-37363: Document internal audit events (GH-14663)

[Miss Islington (bot)]

https://github.com/python/cpython/commit/ed4b3216e59df4806e5ef63b3357fc577a9443d7
commit: ed4b3216e59df4806e5ef63b3357fc577a9443d7
branch: master
author: Christian Heimes <christian at python.org>
committer: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
date: 2019-09-12T06:13:02-07:00
summary:

bpo-37363: Document internal audit events (GH-14663)



Three internal cpython events were not documented, yet.

Signed-off-by: Christian Heimes <christian at python.org>



https://bugs.python.org/issue37363

files:
M Doc/c-api/init.rst

diff --git a/Doc/c-api/init.rst b/Doc/c-api/init.rst
index e0558f426dce..0f8ff3b0dde8 100644
--- a/Doc/c-api/init.rst
+++ b/Doc/c-api/init.rst
@@ -301,8 +301,9 @@ Initializing and finalizing the interpreter
    than once; this can happen if an application calls :c:func:`Py_Initialize` and
    :c:func:`Py_FinalizeEx` more than once.
 
-   .. versionadded:: 3.6
+   .. audit-event:: cpython._PySys_ClearAuditHooks "" c.Py_FinalizeEx
 
+   .. versionadded:: 3.6
 
 .. c:function:: void Py_Finalize()
 
@@ -992,12 +993,16 @@ All of the following functions must be called after :c:func:`Py_Initialize`.
    be held, but may be held if it is necessary to serialize calls to this
    function.
 
+   .. audit-event:: cpython.PyInterpreterState_New "" c.PyInterpreterState_New
+
 
 .. c:function:: void PyInterpreterState_Clear(PyInterpreterState *interp)
 
    Reset all information in an interpreter state object.  The global interpreter
    lock must be held.
 
+   .. audit-event:: cpython.PyInterpreterState_Clear "" c.PyInterpreterState_Clear
+
 
 .. c:function:: void PyInterpreterState_Delete(PyInterpreterState *interp)