[Python-checkins] CVS: python/dist/src/Modules zlibmodule.c,2.53,2.54

[Tim Peters]

Update of /cvsroot/python/python/dist/src/Modules
In directory usw-pr-cvs1:/tmp/cvs-serv19867/python/Modules

Modified Files:
	zlibmodule.c 
Log Message:
Simplify and regularize docstrings.  Also reformat so that each docstring
line fits in reasonable screen width.


Index: zlibmodule.c
===================================================================
RCS file: /cvsroot/python/python/dist/src/Modules/zlibmodule.c,v
retrieving revision 2.53
retrieving revision 2.54
diff -C2 -d -r2.53 -r2.54
*** zlibmodule.c	2001/10/17 03:57:20	2.53
--- zlibmodule.c	2001/10/17 04:16:15	2.54
***************
*** 80,91 ****
  
  static char compressobj__doc__[] =
! "compressobj() -- Return a compressor object.\n"
! "compressobj(level) -- Return a compressor object, using the given compression level.\n"
! ;
  
  static char decompressobj__doc__[] =
! "decompressobj() -- Return a decompressor object.\n"
! "decompressobj(wbits) -- Return a decompressor object, setting the window buffer size to wbits.\n"
! ;
  
  static compobject *
--- 80,91 ----
  
  static char compressobj__doc__[] =
! "compressobj([level]) -- Return a compressor object.\n"
! "\n"
! "Optional arg level is the compression level, in 1-9.";
  
  static char decompressobj__doc__[] =
! "decompressobj([wbits]) -- Return a decompressor object.\n"
! "\n"
! "Optional arg wbits is the window buffer size.";
  
  static compobject *
***************
*** 111,119 ****
  
  static char compress__doc__[] =
! "compress(string) -- Compress string using the default compression level, "
! "returning a string containing compressed data.\n"
! "compress(string, level) -- Compress string, using the chosen compression "
! "level (from 1 to 9).  Return a string containing the compressed data.\n"
! ;
  
  static PyObject *
--- 111,117 ----
  
  static char compress__doc__[] =
! "compress(string[, level]) -- Returned compressed string.\n"
! "\n"
! "Optional arg level is the compression level, in 1-9.";
  
  static PyObject *
***************
*** 189,196 ****
  
  static char decompress__doc__[] =
! "decompress(string) -- Decompress the data in string, returning a string containing the decompressed data.\n"
! "decompress(string, wbits) -- Decompress the data in string with a window buffer size of wbits.\n"
! "decompress(string, wbits, bufsize) -- Decompress the data in string with a window buffer size of wbits and an initial output buffer size of bufsize.\n"
! ;
  
  static PyObject *
--- 187,194 ----
  
  static char decompress__doc__[] =
! "decompress(string[, wbits[, bufsize]]) -- Return decompressed string.\n"
! "\n"
! "Optional arg wbits is the window buffer size.  Optional arg bufsize is\n"
! "the initial output buffer size.";
  
  static PyObject *
***************
*** 381,389 ****
  
  static char comp_compress__doc__[] =
! "compress(data) -- Return a string containing a compressed version of the data.\n\n"
  "After calling this function, some of the input data may still\n"
  "be stored in internal buffers for later processing.\n"
! "Call the flush() method to clear these buffers."
! ;
  
  
--- 379,387 ----
  
  static char comp_compress__doc__[] =
! "compress(data) -- Return a string containing data compressed.\n"
! "\n"
  "After calling this function, some of the input data may still\n"
  "be stored in internal buffers for later processing.\n"
! "Call the flush() method to clear these buffers.";
  
  
***************
*** 451,463 ****
  
  static char decomp_decompress__doc__[] =
! "decompress(data, max_length) -- Return a string containing\n"
! "the decompressed version of the data.\n\n"
! "After calling this function, some of the input data may still\n"
! "be stored in internal buffers for later processing.\n"
  "Call the flush() method to clear these buffers.\n"
  "If the max_length parameter is specified then the return value will be\n"
  "no longer than max_length.  Unconsumed input data will be stored in\n"
! "the unconsumed_tail attribute."
! ;
  
  static PyObject *
--- 449,461 ----
  
  static char decomp_decompress__doc__[] =
! "decompress(data, max_length) -- Return a string containing the decompressed\n"
! "version of the data.\n"
! "\n"
! "After calling this function, some of the input data may still be stored in\n"
! "internal buffers for later processing.\n"
  "Call the flush() method to clear these buffers.\n"
  "If the max_length parameter is specified then the return value will be\n"
  "no longer than max_length.  Unconsumed input data will be stored in\n"
! "the unconsumed_tail attribute.";
  
  static PyObject *
***************
*** 575,583 ****
  static char comp_flush__doc__[] =
  "flush( [mode] ) -- Return a string containing any remaining compressed data.\n"
! "mode can be one of the constants Z_SYNC_FLUSH, Z_FULL_FLUSH, Z_FINISH; the \n"
  "default value used when mode is not specified is Z_FINISH.\n"
  "If mode == Z_FINISH, the compressor object can no longer be used after\n"
! "calling the flush() method.  Otherwise, more data can still be compressed.\n"
! ;
  
  static PyObject *
--- 573,581 ----
  static char comp_flush__doc__[] =
  "flush( [mode] ) -- Return a string containing any remaining compressed data.\n"
! "\n"
! "mode can be one of the constants Z_SYNC_FLUSH, Z_FULL_FLUSH, Z_FINISH; the\n"
  "default value used when mode is not specified is Z_FINISH.\n"
  "If mode == Z_FINISH, the compressor object can no longer be used after\n"
! "calling the flush() method.  Otherwise, more data can still be compressed.\n";
  
  static PyObject *
***************
*** 663,669 ****
  
  static char decomp_flush__doc__[] =
! "flush() -- Return a string containing any remaining decompressed data.  "
! "The decompressor object can no longer be used after this call."
! ;
  
  static PyObject *
--- 661,667 ----
  
  static char decomp_flush__doc__[] =
! "flush() -- Return a string containing any remaining decompressed data.\n"
! "\n"
! "The decompressor object can no longer be used after this call.";
  
  static PyObject *
***************
*** 744,752 ****
  
  static char adler32__doc__[] =
! "adler32(string) -- Compute an Adler-32 checksum of string, using "
! "a default starting value, and returning an integer value.\n"
! "adler32(string, value) -- Compute an Adler-32 checksum of string, using "
! "the starting value provided, and returning an integer value\n"
! ;
  
  static PyObject *
--- 742,749 ----
  
  static char adler32__doc__[] =
! "adler32(string[, start]) -- Compute an Adler-32 checksum of string.\n"
! "\n"
! "An optional starting value can be specified.  The returned checksum is\n"
! "an integer.";
  
  static PyObject *
***************
*** 764,772 ****
  
  static char crc32__doc__[] =
! "crc32(string) -- Compute a CRC-32 checksum of string, using "
! "a default starting value, and returning an integer value.\n"
! "crc32(string, value) -- Compute a CRC-32 checksum of string, using "
! "the starting value provided, and returning an integer value.\n"
! ;
  
  static PyObject *
--- 761,768 ----
  
  static char crc32__doc__[] =
! "crc32(string[, start]) -- Compute a CRC-32 checksum of string.\n"
! "\n"
! "An optional starting value can be specified.  The returned checksum is\n"
! "an integer.";
  
  static PyObject *
***************
*** 854,871 ****
  
  static char zlib_module_documentation[]=
! "The functions in this module allow compression and decompression "
! "using the zlib library, which is based on GNU zip.  \n\n"
! "adler32(string) -- Compute an Adler-32 checksum.\n"
! "adler32(string, start) -- Compute an Adler-32 checksum using a given starting value.\n"
! "compress(string) -- Compress a string.\n"
! "compress(string, level) -- Compress a string with the given level of compression (1--9).\n"
  "compressobj([level]) -- Return a compressor object.\n"
! "crc32(string) -- Compute a CRC-32 checksum.\n"
! "crc32(string, start) -- Compute a CRC-32 checksum using a given starting value.\n"
  "decompress(string,[wbits],[bufsize]) -- Decompresses a compressed string.\n"
! "decompressobj([wbits]) -- Return a decompressor object (wbits=window buffer size).\n\n"
! "Compressor objects support compress() and flush() methods; decompressor \n"
! "objects support decompress() and flush()."
! ;
  
  DL_EXPORT(void)
--- 850,866 ----
  
  static char zlib_module_documentation[]=
! "The functions in this module allow compression and decompression using the\n"
! "zlib library, which is based on GNU zip.\n"
! "\n"
! "adler32(string[, start]) -- Compute an Adler-32 checksum.\n"
! "compress(string[, level]) -- Compress string, with compression level in 1-9.\n"
  "compressobj([level]) -- Return a compressor object.\n"
! "crc32(string[, start]) -- Compute a CRC-32 checksum.\n"
  "decompress(string,[wbits],[bufsize]) -- Decompresses a compressed string.\n"
! "decompressobj([wbits]) -- Return a decompressor object.\n"
! "\n"
! "'wbits' is window buffer size.\n"
! "Compressor objects support compress() and flush() methods; decompressor\n"
! "objects support decompress() and flush().";
  
  DL_EXPORT(void)