diff options
| author | Steve Dower <steve.dower@python.org> | 2019-06-27 10:47:59 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-06-27 10:47:59 -0700 |
| commit | 44f91c388a6f4da9ed3300df32ca290b8aa104ea (patch) | |
| tree | 6e02d501dbcb28708fa662a33da2715a505389e5 /Doc/library/os.rst | |
| parent | 21cfae107e410bf4b0ab3c142ca4449bc33290f5 (diff) | |
| download | cpython-git-44f91c388a6f4da9ed3300df32ca290b8aa104ea.tar.gz | |
bpo-37390: Add audit event table to documentations (GH-14406)
Also updates some (unreleased) event names to be consistent with the others.
Diffstat (limited to 'Doc/library/os.rst')
| -rw-r--r-- | Doc/library/os.rst | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/Doc/library/os.rst b/Doc/library/os.rst index 45ce643d88..ee3c35c2a9 100644 --- a/Doc/library/os.rst +++ b/Doc/library/os.rst @@ -851,7 +851,7 @@ as internal buffering of data. most *length* bytes in size. As of Python 3.3, this is equivalent to ``os.truncate(fd, length)``. - .. audit-event:: os.truncate "fd length" + .. audit-event:: os.truncate fd,length os.ftruncate .. availability:: Unix, Windows. @@ -938,7 +938,7 @@ as internal buffering of data. This function can support :ref:`paths relative to directory descriptors <dir_fd>` with the *dir_fd* parameter. - .. audit-event:: open "path mode flags" + .. audit-event:: open path,mode,flags os.open .. versionchanged:: 3.4 The new file descriptor is now non-inheritable. @@ -1806,7 +1806,7 @@ features: This function can also support :ref:`specifying a file descriptor <path_fd>`; the file descriptor must refer to a directory. - .. audit-event:: os.listdir path + .. audit-event:: os.listdir path os.listdir .. note:: To encode ``str`` filenames to ``bytes``, use :func:`~os.fsencode`. @@ -2185,7 +2185,7 @@ features: This function can also support :ref:`specifying a file descriptor <path_fd>`; the file descriptor must refer to a directory. - .. audit-event:: os.scandir path + .. audit-event:: os.scandir path os.scandir The :func:`scandir` iterator supports the :term:`context manager` protocol and has the following method: @@ -2793,7 +2793,7 @@ features: This function can support :ref:`specifying a file descriptor <path_fd>`. - .. audit-event:: os.truncate "path length" + .. audit-event:: os.truncate path,length os.truncate .. availability:: Unix, Windows. @@ -3799,7 +3799,7 @@ written in Python, such as a mail server's external command delivery program. to using this function. See the :ref:`subprocess-replacements` section in the :mod:`subprocess` documentation for some helpful recipes. - .. audit-event:: os.system command + .. audit-event:: os.system command os.system .. availability:: Unix, Windows. |