mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-26 18:29:57 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 10

bpo-41180: Fixes documentation to specify correct event name and add versionchanged (GH-26972)

Browse source
This commit is contained in:
Steve Dower 2021-06-30 18:53:13 +01:00 • committed by GitHub
parent 139de04518
commit 95919b0d27
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

12
Doc/library/marshal.rst
View file

@ -76,13 +76,18 @@ The module defines these functions:
format), raise :exc:`EOFError`, :exc:`ValueError` or :exc:`TypeError`. The format), raise :exc:`EOFError`, :exc:`ValueError` or :exc:`TypeError`. The
file must be a readable :term:`binary file`. file must be a readable :term:`binary file`.
.. audit-event:: marshal.loads bytes marshal.load .. audit-event:: marshal.load "" marshal.load
.. note:: .. note::
If an object containing an unsupported type was marshalled with :func:`dump`, If an object containing an unsupported type was marshalled with :func:`dump`,
:func:`load` will substitute ``None`` for the unmarshallable type. :func:`load` will substitute ``None`` for the unmarshallable type.
.. versionchanged:: 3.10
This call used to raise a ``code.__new__`` audit event for each code object. Now
it raises a single ``marshal.load`` event for the entire load operation.
.. function:: dumps(value[, version]) .. function:: dumps(value[, version])
@ -104,6 +109,11 @@ The module defines these functions:
.. audit-event:: marshal.loads bytes marshal.load .. audit-event:: marshal.loads bytes marshal.load
.. versionchanged:: 3.10
This call used to raise a ``code.__new__`` audit event for each code object. Now
it raises a single ``marshal.loads`` event for the entire load operation.
In addition, the following constants are defined: In addition, the following constants are defined: