Commit Graph

34 Commits

Author SHA1 Message Date
Georg Brandl 22a9dc889d Patch #1459631: documnent zlib.Decompress.flush() length parameter. 2006-04-01 07:39:41 +00:00
Andrew M. Kuchling c1c956b281 Remove statement about meaning of constants; arguably it's incorrect 2005-09-01 14:08:38 +00:00
Andrew M. Kuchling 2330e9eed9 From c.l.py comments: link to zlib manual, and disclaim completeness 2005-08-31 16:52:40 +00:00
Raymond Hettinger f964154b8c Bug #1088206: zlib decompressobj documentation typo 2004-12-20 06:08:12 +00:00
Andrew M. Kuchling 57712b3d9a Remove the current version of zlib (we'll just have to keep updating it); rewrite following sentence to make sense without the previous one 2004-10-19 19:50:23 +00:00
Andrew M. Kuchling 5fcc003566 [Bug #1049826] Update version of zlib referenced in text 2004-10-19 18:52:49 +00:00
Martin v. Löwis 9e9a7c3dd7 Patch #640236: Better eplain unused data. 2003-06-21 14:15:25 +00:00
Jeremy Hylton 511e2cacc4 [ #403753 ] zlib decompress; uncontrollable memory usage
Mostly by Toby Dickenson and Titus Brown.

Add an optional argument to a decompression object's decompress()
method.  The argument specifies the maximum length of the return
value.  If the uncompressed data exceeds this length, the excess data
is stored as the unconsumed_tail attribute.  (Not to be confused with
unused_data, which is a separate issue.)

Difference from SF patch: Default value for unconsumed_tail is ""
rather than None.  It's simpler if the attribute is always a string.
2001-10-16 20:39:49 +00:00
Fred Drake 327798ca4a Added notes to clarify that binascii.crc32(), zlib.crc32(), and
zlib.adler32() are not suitable as general hash functions.
2001-10-15 13:45:49 +00:00
Fred Drake b037d33245 Updated link to zlib's home page. 2001-06-25 15:30:13 +00:00
Fred Drake bc524c4e9f Cut-&-paste-o noted by Wolfgang Teschner: decompressobj() returns
*DE*compression objects, not compression objects!
2001-04-18 20:16:51 +00:00
Fred Drake ba0a989988 Make all the \seemodule explanations consistent: start with a capitalized
letter and end with proper punctuation.  "Documenting Python" will be
updated accordingly so that this will be editorial policy for the Python
documentation.
2000-10-18 17:43:06 +00:00
Fred Drake 315b9e0ac1 Update *both* uses of the URL to the zlib home page, and use the version
advertised as the canonical form.
2000-09-16 06:18:26 +00:00
Fred Drake ab2f9f766f Update link to the zlib homepage. 2000-09-16 05:07:03 +00:00
Fred Drake 38e5d27cae Merged changes from the 1.5.2p2 release.
(Very rough.)
2000-04-03 20:13:55 +00:00
Fred Drake b11d108cdc The version information here was checked good in 1999, not 199. ;-)
Added "See also" reference to zlib home page, even though it's
mentioned in the text.
1999-04-21 18:44:41 +00:00
Jeremy Hylton 45b0aeda3c correct version info for zlib.
add note about module failing with old versions of the library.

update comment that explains that this doc is *still* out of date
1999-04-05 21:55:21 +00:00
Fred Drake bbac43223c Shorten a few section titles. 1999-02-20 00:14:17 +00:00
Andrew M. Kuchling f07c328c07 Document the optional mode argument (Z_FLUSH, Z_SYNC_FLUSH, etc.)
to the flush() method of compressor objects.
1998-12-31 21:14:23 +00:00
Fred Drake 295da24eaf New section header style.
Fix up a few synopses.
1998-08-10 19:42:37 +00:00
Fred Drake 08caa964c4 Added a synopsis. 1998-07-27 22:08:49 +00:00
Fred Drake b91e934cf1 Adjusted to use the new module synopsis support macros. 1998-07-23 17:59:49 +00:00
Fred Drake 59160706b3 Somewhat updated, but not checked for everything (just the stuff I was using). 1998-06-19 21:18:28 +00:00
Fred Drake 8a254b5967 Removed misleading comment about GNU software. This module and the zlib
library have no relationship with GNU software other than implementing some of
the same algorithms and file format.  (The zlib module is more general.)
1998-04-09 15:41:44 +00:00
Fred Drake b208f128b4 Added index entry. 1998-04-04 06:28:54 +00:00
Fred Drake 74810d5abb Nits.
Add {excdesc} for zlib.error.

Use {methoddesc} where appropriate.
1998-04-03 06:49:26 +00:00
Fred Drake cce1090d49 Change "\," to just "," in function signatures. This is easier to maintain,
works better with LaTeX2HTML, and allows some simplification of the python.sty
macros.
1998-03-17 06:33:25 +00:00
Fred Drake 1947991c2f Remove all \bcode / \ecode cruft; this is no longer needed. See previous
checkin of myformat.sty.

Change "\renewcommand{\indexsubitem}{(...)}" to "\setindexsubitem{(...)}"
everywhere.

Some other minor nits that I happened to come across.
1998-02-13 06:58:54 +00:00
Fred Drake ed79783bb2 Converted to use new macros. This example demonstrate \method{} and, more
importantly, \url{}.
1998-01-22 16:11:18 +00:00
Guido van Rossum eb0f066fb8 Correct small nits reported by Rob Hooft. 1997-12-30 20:38:16 +00:00
Guido van Rossum e47da0ae04 AMK's megapatch:
* \bcode, \ecode added everywhere
	* \label{module-foo} added everywhere
	* A few \seealso sections added.
	* Indentation fixed inside verbatim in lib*tex files
1997-07-17 16:34:52 +00:00
Guido van Rossum 2525bedfc0 Fix a sentence which ends "...is 6, which." (AMK) 1997-06-02 17:22:06 +00:00
Guido van Rossum 412154f3c7 Updated web ref and version#. Folded some long lines. 1997-04-30 19:39:21 +00:00
Guido van Rossum 04bc9d6e67 zlib by AMK 1997-04-30 18:12:27 +00:00