aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSam James <sam@gentoo.org>2022-09-25 01:20:54 +0100
committerArthur Zamarin <arthurzam@gentoo.org>2022-10-10 19:48:52 +0300
commit135e855953fe7a648d0fd794909445093086bd64 (patch)
treead41198027a80d9c61be664da02a9eb97f86296f
parentcompression: add parallel xz support (diff)
downloadsnakeoil-135e855953fe7a648d0fd794909445093086bd64.tar.gz
snakeoil-135e855953fe7a648d0fd794909445093086bd64.tar.bz2
snakeoil-135e855953fe7a648d0fd794909445093086bd64.zip
compression: tidy up bzip2 docs
Signed-off-by: Sam James <sam@gentoo.org> Closes: https://github.com/pkgcore/snakeoil/pull/84 Signed-off-by: Arthur Zamarin <arthurzam@gentoo.org>
-rw-r--r--src/snakeoil/compression/_bzip2.py6
1 files changed, 3 insertions, 3 deletions
diff --git a/src/snakeoil/compression/_bzip2.py b/src/snakeoil/compression/_bzip2.py
index b10e3ec..1a38922 100644
--- a/src/snakeoil/compression/_bzip2.py
+++ b/src/snakeoil/compression/_bzip2.py
@@ -1,11 +1,11 @@
"""
bzip2 decompression/compression
-where possible, this module defers to cpython bz2 module- if it's not available,
-it results to executing bzip2 with tempfile arguments to do decompression
+Where possible, this module defers to cpython's bz2 module - if it's not available,
+it defers to executing bzip2 with tempfile arguments to do decompression
and compression.
-Should use this module unless its absolutely critical that bz2 module be used
+Use this module unless it's absolutely critical that the bz2 module is used.
"""
__all__ = ("compress_data", "decompress_data")