[Jython-checkins] SF.net SVN: jython:[5610] trunk/jython/Lib/zlib.py

[<pj...@us...>]

Revision: 5610
          http://jython.svn.sourceforge.net/jython/?rev=5610&view=rev
Author:   pjenvey
Date:     2008-11-23 04:35:59 +0000 (Sun, 23 Nov 2008)

Log Message:
-----------
zlib docs
fixes #1798554, #1798556
thanks ukeshav

Modified Paths:
--------------
    trunk/jython/Lib/zlib.py

Modified: trunk/jython/Lib/zlib.py
===================================================================
--- trunk/jython/Lib/zlib.py	2008-11-23 04:18:48 UTC (rev 5609)
+++ trunk/jython/Lib/zlib.py	2008-11-23 04:35:59 UTC (rev 5610)
@@ -1,3 +1,18 @@
+"""
+The functions in this module allow compression and decompression using the
+zlib library, which is based on GNU zip.
+
+adler32(string[, start]) -- Compute an Adler-32 checksum.
+compress(string[, level]) -- Compress string, with compression level in 1-9.
+compressobj([level]) -- Return a compressor object.
+crc32(string[, start]) -- Compute a CRC-32 checksum.
+decompress(string,[wbits],[bufsize]) -- Decompresses a compressed string.
+decompressobj([wbits]) -- Return a decompressor object.
+
+'wbits' is window buffer size.
+Compressor objects support compress() and flush() methods; decompressor
+objects support decompress() and flush().
+"""
 import jarray, binascii
 
 from java.util.zip import Adler32, Deflater, Inflater


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.