summaryrefslogtreecommitdiff
path: root/Doc/library
diff options
context:
space:
mode:
authorTerry Jan Reedy <tjreedy@udel.edu>2019-11-26 12:07:48 -0500
committerSteve Dower <steve.dower@python.org>2019-11-26 09:07:48 -0800
commite563a155be60fc0757914f87c8138f10de00bb16 (patch)
tree291d892346286841768879380651fa733352839f /Doc/library
parentbc441ed7c1449f06df37905ee6289aa93b85d4cb (diff)
downloadcpython-git-e563a155be60fc0757914f87c8138f10de00bb16.tar.gz
bpo-38892: Improve docs for audit event (GH-17361)
Diffstat (limited to 'Doc/library')
-rw-r--r--Doc/library/audit_events.rst2
-rw-r--r--Doc/library/sys.rst6
2 files changed, 4 insertions, 4 deletions
diff --git a/Doc/library/audit_events.rst b/Doc/library/audit_events.rst
index c23b9c6183..3c68a1515b 100644
--- a/Doc/library/audit_events.rst
+++ b/Doc/library/audit_events.rst
@@ -7,7 +7,7 @@ Audit events table
This table contains all events raised by :func:`sys.audit` or
:c:func:`PySys_Audit` calls throughout the CPython runtime and the
-standard library.
+standard library. These calls were added in 3.8.0 or later.
See :func:`sys.addaudithook` and :c:func:`PySys_AddAuditHook` for
information on handling these events.
diff --git a/Doc/library/sys.rst b/Doc/library/sys.rst
index 4b0bcde4a8..2f33445a6f 100644
--- a/Doc/library/sys.rst
+++ b/Doc/library/sys.rst
@@ -25,7 +25,7 @@ always available.
.. function:: addaudithook(hook)
- Adds the callable *hook* to the collection of active auditing hooks for the
+ Append the callable *hook* to the list of active auditing hooks for the
current interpreter.
When an auditing event is raised through the :func:`sys.audit` function, each
@@ -35,7 +35,7 @@ always available.
.. audit-event:: sys.addaudithook "" sys.addaudithook
- Raises a auditing event ``sys.addaudithook`` with no arguments. If any
+ Raise an auditing event ``sys.addaudithook`` with no arguments. If any
existing hooks raise an exception derived from :class:`Exception`, the
new hook will not be added and the exception suppressed. As a result,
callers cannot assume that their hook has been added unless they control
@@ -74,7 +74,7 @@ always available.
.. index:: single: auditing
- Raises an auditing event with any active hooks. The event name is a string
+ Raise an auditing event with any active hooks. The event name is a string
identifying the event and its associated schema, which is the number and
types of arguments. The schema for a given event is considered public and
stable API and should not be modified between releases.