From: Guido van Rossum <guido@python.org>
Date: Wed, 16 Feb 2000 21:13:37 +0000 (+0000)
Subject: Added docs for new crc32() function.  By Jim Ahlstrom.
X-Git-Tag: v1.6a1~409
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=8006d316bcf10af9f3d22530ce88358370aec10b;p=thirdparty%2FPython%2Fcpython.git

Added docs for new crc32() function.  By Jim Ahlstrom.

(Fred, please check.)
---

diff --git a/Doc/lib/libbinascii.tex b/Doc/lib/libbinascii.tex
index 470a7afdf3e6..bbc7f4410b11 100644
--- a/Doc/lib/libbinascii.tex
+++ b/Doc/lib/libbinascii.tex
@@ -71,6 +71,18 @@ length divisible by 3 (except possibly the last fragment).
 Compute the binhex4 crc value of \var{data}, starting with an initial
 \var{crc} and returning the result.
 \end{funcdesc}
+
+\begin{funcdesc}{crc32}{data\optional{, crc}}
+Compute CRC-32, the 32-bit checksum of data, starting with an initial
+crc.  This is consistent with the ZIP file checksum.  Use as follows:
+\begin{verbatim}
+    print binascii.crc32("hello world")
+    # Or, in two pieces:
+    crc = binascii.crc32("hello")
+    crc = binascii.crc32(" world", crc)
+    print crc
+\end{verbatim}
+\end{funcdesc}
  
 \begin{excdesc}{Error}
 Exception raised on errors. These are usually programming errors.