Skip to content

Commit 8fc496d

Browse files
rhpvordermanrhpvorderman
committed
Use a list table as it allows linebreaks
1 parent 700674e commit 8fc496d

File tree

1 file changed

+61
-38
lines changed

1 file changed

+61
-38
lines changed

‎src/isal/igzip_libmodule.c

Lines changed: 61 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -485,44 +485,67 @@ PyDoc_STRVAR(igizp_lib_module_documentation,
485485
"\n"
486486
"This module comes with the following constants:\n"
487487
"\n"
488-
"============================== ================================================\n"
489-
"``ISAL_BEST_SPEED`` The lowest compression level (0)\n"
490-
"``ISAL_BEST_COMPRESSION`` The highest compression level (3)\n"
491-
" ``ISAL_DEFAULT_COMPRESSION`` The compromise compression level (2)\n"
492-
"``DEF_BUF_SIZE`` Default size for the starting buffer (16K)\n"
493-
"``MAX_HIST_BITS`` Maximum window size bits (15).\n"
494-
"``COMP_DEFLATE`` Flag to compress to a raw deflate block\n"
495-
"``COMP_GZIP`` Flag to compress a gzip block, consisting of a\n"
496-
" gzip header, raw deflate block and a gzip\n"
497-
" trailer.\n"
498-
"``COMP_GZIP_NO_HDR`` Flag to compress a gzip block without a header.\n"
499-
"``COMP_ZLIB`` Flag to compress a zlib block, consisting of a\n"
500-
" zlib header, a raw deflate block and a zlib\n"
501-
" trailer.\n"
502-
"``COMP_ZLIB_NO_HDR`` Flag to compress a zlib block without a header.\n"
503-
"``DECOMP_DEFLATE`` Flag to decompress a raw deflate block.\n"
504-
"``DECOMP_GZIP`` Flag to decompress a gzip block including header\n"
505-
" and verify the checksums in the trailer.\n"
506-
"``DECOMP_GZIP_NO_HDR`` Decompresses a raw deflate block (no header,\n"
507-
" no trailer) and updates the crc member on the\n"
508-
" IgzipDecompressor object with a crc32 checksum.\n"
509-
"``DECOMP_GZIP_NO_HDR_VER`` Like DECOMP_GZIP_NO_HDR but reads the trailer\n"
510-
" and verifies the crc32 checksum.\n"
511-
"``DECOMP_ZLIB`` Flag to decompress a zlib block including header\n"
512-
" and verify the checksums in the trailer.\n"
513-
"``DECOMP_ZLIB_NO_HDR`` Decompresses a raw deflate block (no header,\n"
514-
" no trailer) and updates the crc member on the\n"
515-
" IgzipDecompressor object with an adler32 checksum.\n"
516-
"``DECOMP_ZLIB_NO_HDR_VER`` Like DECOMP_ZLIB_NO_HDR but reads the trailer\n"
517-
" and verifies the adler32 checksum.\n"
518-
"``MEM_LEVEL_DEFAULT`` The default memory level for the internal level\n"
519-
" buffer. (Equivalent to MEM_LEVEL_LARGE.)\n"
520-
"``MEM_LEVEL_MIN`` The minimum memory level.\n"
521-
"``MEM_LEVEL_SMALL``\n"
522-
"``MEM_LEVEL_MEDIUM``\n"
523-
"``MEM_LEVEL_LARGE``\n"
524-
"``MEM_LEVEL_EXTRA_LARGE`` The largest memory level.\n"
525-
"============================== ================================================\n"
488+
".. list-table::\n"
489+
" :widths: 20 60\n"
490+
" :header-rows: 0\n"
491+
"\n"
492+
" * - ``ISAL_BEST_SPEED``\n"
493+
" - The lowest compression level (0)\n"
494+
" * - ``ISAL_BEST_COMPRESSION``\n"
495+
" - The highest compression level (3)\n"
496+
" * - ``ISAL_DEFAULT_COMPRESSION``\n"
497+
" - The compromise compression level (2)\n"
498+
" * - ``DEF_BUF_SIZE``\n"
499+
" - Default size for the starting buffer (16K)\n"
500+
" * - ``MAX_HIST_BITS``\n"
501+
" - Maximum window size bits (15).\n"
502+
" * - ``COMP_DEFLATE``\n"
503+
" - Flag to compress to a raw deflate block\n"
504+
" * - ``COMP_GZIP``\n"
505+
" - | Flag to compress a gzip block, consisting of a gzip header, a raw\n"
506+
" | deflate block and a gzip trailer.\n"
507+
" * - ``COMP_GZIP_NO_HDR``\n"
508+
" - Flag to compress a gzip block without a header.\n"
509+
" * - ``COMP_ZLIB``\n"
510+
" - | Flag to compress a zlib block, consisting of a zlib header, a raw\n"
511+
" | deflate block and a zlib trailer.\n"
512+
" * - ``COMP_ZLIB_NO_HDR``\n"
513+
" - Flag to compress a zlib block without a header.\n"
514+
" * - ``DECOMP_DEFLATE``\n"
515+
" - Flag to decompress a raw deflate block.\n"
516+
" * - ``DECOMP_GZIP``\n"
517+
" - | Flag to decompress a gzip block including header and verify the\n"
518+
" | checksums in the trailer.\n"
519+
" * - ``DECOMP_GZIP_NO_HDR``\n"
520+
" - | Decompresses a raw deflate block (no header, no trailer) and \n"
521+
" | updates the crc member on the IgzipDecompressor object with a \n"
522+
" | crc32 checksum.\n"
523+
" * - ``DECOMP_GZIP_NO_HDR_VER``\n"
524+
" - | Like DECOMP_GZIP_NO_HDR but reads the trailer and verifies the \n"
525+
" | crc32 checksum.\n"
526+
" * - ``DECOMP_ZLIB``\n"
527+
" - | Flag to decompress a zlib block including header and verify the\n"
528+
" | checksums in the trailer.\n"
529+
" * - ``DECOMP_ZLIB_NO_HDR``\n"
530+
" - | Decompresses a raw deflate block (no header, no trailer) and \n"
531+
" | updates the crc member on the IgzipDecompressor object with an \n"
532+
" | adler32 checksum.\n"
533+
" * - ``DECOMP_ZLIB_NO_HDR_VER``\n"
534+
" - | Like DECOMP_ZLIB_NO_HDR but reads the trailer and verifies the \n"
535+
" | adler32 checksum.\n"
536+
" * - ``MEM_LEVEL_DEFAULT``\n"
537+
" - | The default memory level for the internal level buffer. \n"
538+
" | (Equivalent to MEM_LEVEL_LARGE.)\n"
539+
" * - ``MEM_LEVEL_MIN``\n"
540+
" - The minimum memory level.\n"
541+
" * - ``MEM_LEVEL_SMALL``\n"
542+
" - \n"
543+
" * - ``MEM_LEVEL_MEDIUM``\n"
544+
" - \n"
545+
" * - ``MEM_LEVEL_LARGE``\n"
546+
" - \n"
547+
" * - ``MEM_LEVEL_EXTRA_LARGE``\n"
548+
" - The largest memory level.\n"
526549
);
527550

528551
static struct PyModuleDef igzip_lib_module = {

0 commit comments

Comments
 (0)