diff options
author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2019-11-26 17:14:48 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-11-26 17:14:48 (GMT) |
commit | 86d9933cc627c4232f9702ca0766713714ebbc53 (patch) | |
tree | 01bf7a0be3df35c90bda017aa3f2b346dd87e421 /Doc/library/sys.rst | |
parent | dadff6f6610e03a9363c52ba9c49aa923984640a (diff) | |
download | cpython-86d9933cc627c4232f9702ca0766713714ebbc53.zip cpython-86d9933cc627c4232f9702ca0766713714ebbc53.tar.gz cpython-86d9933cc627c4232f9702ca0766713714ebbc53.tar.bz2 |
bpo-38892: Improve docs for audit event (GH-17361)
(cherry picked from commit e563a155be60fc0757914f87c8138f10de00bb16)
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
Diffstat (limited to 'Doc/library/sys.rst')
-rw-r--r-- | Doc/library/sys.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/Doc/library/sys.rst b/Doc/library/sys.rst index 0e15467..8d0de47 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. |