X-Git-Url: https://wannabe.guru.org/gitweb/?a=blobdiff_plain;f=docs%2Fpyutils.compress.rst;h=7957494e773138987ff211aed2045132a97bb944;hb=a2cb839d6932060ea00ad9b9d7c198ab310affe4;hp=e07a5e97e2b0f745abc0dcabf9ada5776830c9b3;hpb=1c60a8d9ae5a162f8d309b48f8a07ee6946f3e25;p=pyutils.git

diff --git a/docs/pyutils.compress.rst b/docs/pyutils.compress.rst
index e07a5e9..7957494 100644
--- a/docs/pyutils.compress.rst
+++ b/docs/pyutils.compress.rst
@@ -7,6 +7,11 @@ Submodules
 pyutils.compress.letter\_compress module
 ----------------------------------------
 
+This is a simple, honestly, toy compression scheme that uses a custom
+alphabet of 32 characters which can each be represented in six bits
+instead of eight.  It therefore reduces the size of data composed of
+only those letters by 25% without loss.
+
 .. automodule:: pyutils.compress.letter_compress
    :members:
    :undoc-members: