Commit 2330e9ee authored by Andrew M. Kuchling's avatar Andrew M. Kuchling

From c.l.py comments: link to zlib manual, and disclaim completeness

parent 8230df39
...@@ -8,11 +8,16 @@ ...@@ -8,11 +8,16 @@
For applications that require data compression, the functions in this For applications that require data compression, the functions in this
module allow compression and decompression, using the zlib library. module allow compression and decompression, using the zlib library.
The zlib library has its own home page at \url{http://www.gzip.org/zlib/}. The zlib library has its own home page at \url{http://www.zlib.net}.
There are known incompatibilities between the Python module and There are known incompatibilities between the Python module and
versions of the zlib library earlier than 1.1.3; 1.1.3 has a security versions of the zlib library earlier than 1.1.3; 1.1.3 has a security
vulnerability, so we recommend using 1.1.4 or later. vulnerability, so we recommend using 1.1.4 or later.
zlib's functions have many options and often need to be used in a
particular order. This documentation doesn't attempt to cover all of
the permutations; consult the zlib manual at
\url{http://www.zlib.net/manual.html} for authoritative information.
The available exception and functions in this module are: The available exception and functions in this module are:
\begin{excdesc}{error} \begin{excdesc}{error}
...@@ -171,5 +176,7 @@ action is to delete the object. ...@@ -171,5 +176,7 @@ action is to delete the object.
\begin{seealso} \begin{seealso}
\seemodule{gzip}{Reading and writing \program{gzip}-format files.} \seemodule{gzip}{Reading and writing \program{gzip}-format files.}
\seeurl{http://www.gzip.org/zlib/}{The zlib library home page.} \seeurl{http://www.zlib.net}{The zlib library home page.}
\seeurl{http://www.zlib.net/manual.html}{The zlib manual explains
the semantics and usage of the library's many functions.}
\end{seealso} \end{seealso}
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment