More work to improve the quality of sphinx autodocs.

[pyutils.git] / docs / pyutils.compress.rst

diff --git a/docs/pyutils.compress.rst b/docs/pyutils.compress.rst
index e07a5e97e2b0f745abc0dcabf9ada5776830c9b3..7957494e773138987ff211aed2045132a97bb944 100644 (file)
--- 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: