mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-11-03 19:34:08 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 9

Fix a few markup nits in zlib docs and add missing versionchanged tags.

Browse source
This commit is contained in:
Georg Brandl 2012-06-26 08:51:17 +02:00
parent 5b2f9c0aff
commit 9aae9e5e6b
1 changed files with 21 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

33
Doc/library/zlib.rst
View file

@ -58,7 +58,7 @@ The available exception and functions in this module are:
exception if any error occurs. exception if any error occurs.
.. function:: compressobj(level=-1, method=DEFLATED, wbits=15, memlevel=8, strategy=Z_DEFAULT_STRATEGY, [zdict]) .. function:: compressobj(level=-1, method=DEFLATED, wbits=15, memlevel=8, strategy=Z_DEFAULT_STRATEGY[, zdict])
Returns a compression object, to be used for compressing data streams that won't Returns a compression object, to be used for compressing data streams that won't
fit into memory at once. fit into memory at once.
@ -86,6 +86,10 @@ The available exception and functions in this module are:
to occur frequently in the data that is to be compressed. Those subsequences to occur frequently in the data that is to be compressed. Those subsequences
that are expected to be most common should come at the end of the dictionary. that are expected to be most common should come at the end of the dictionary.
.. versionchanged:: 3.3
Added the *method*, *wbits*, *memlevel*, *strategy* and *zdict*
parameters.
.. function:: crc32(data[, value]) .. function:: crc32(data[, value])
@ -103,12 +107,13 @@ The available exception and functions in this module are:
Always returns an unsigned 32-bit integer. Always returns an unsigned 32-bit integer.
.. note:: .. note::
To generate the same numeric value across all Python versions and
platforms use crc32(data) & 0xffffffff. If you are only using To generate the same numeric value across all Python versions and
the checksum in packed binary format this is not necessary as the platforms, use ``crc32(data) & 0xffffffff``. If you are only using
return value is the correct 32bit binary representation the checksum in packed binary format this is not necessary as the
regardless of sign. return value is the correct 32-bit binary representation
regardless of sign.
.. function:: decompress(data[, wbits[, bufsize]]) .. function:: decompress(data[, wbits[, bufsize]])
@ -135,7 +140,7 @@ The available exception and functions in this module are:
to :c:func:`malloc`. The default size is 16384. to :c:func:`malloc`. The default size is 16384.
.. function:: decompressobj([wbits[, zdict]]) .. function:: decompressobj(wbits=15[, zdict])
Returns a decompression object, to be used for decompressing data streams that Returns a decompression object, to be used for decompressing data streams that
won't fit into memory at once. won't fit into memory at once.
@ -146,10 +151,14 @@ The available exception and functions in this module are:
provided, this must be the same dictionary as was used by the compressor that provided, this must be the same dictionary as was used by the compressor that
produced the data that is to be decompressed. produced the data that is to be decompressed.
.. note:: .. note::
If *zdict* is a mutable object (such as a :class:`bytearray`), you must not
modify its contents between the call to :func:`decompressobj` and the first If *zdict* is a mutable object (such as a :class:`bytearray`), you must not
call to the decompressor's ``decompress()`` method. modify its contents between the call to :func:`decompressobj` and the first
call to the decompressor's ``decompress()`` method.
.. versionchanged:: 3.3
Added the *zdict* parameter.
Compression objects support the following methods: Compression objects support the following methods: