]> granicus.if.org Git - python/commitdiff
Added docs for new crc32() function. By Jim Ahlstrom.
authorGuido van Rossum <guido@python.org>
Wed, 16 Feb 2000 21:13:37 +0000 (21:13 +0000)
committerGuido van Rossum <guido@python.org>
Wed, 16 Feb 2000 21:13:37 +0000 (21:13 +0000)
(Fred, please check.)

Doc/lib/libbinascii.tex

index 470a7afdf3e6fb441b0efbd6d553aef4d86bfe93..bbc7f4410b1134d368647a211ea1e029bdf76ce1 100644 (file)
@@ -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.