Skip to content

Commit 9ff6320

Browse files
committed
Add reference to zstd manual and blurb on algorithm
1 parent f25e6e7 commit 9ff6320

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

Doc/library/compression.zstd.rst

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,14 @@
1111

1212
--------------
1313

14-
This module provides classes and functions for compressing and
15-
decompressing data using the Zstandard (or *zstd*) compression algorithm. Also
16-
included is a file interface that supports reading and writing the contents of
17-
``.zst`` files created by the :program:`zstd` utility, as well as raw zstd
18-
compressed streams.
14+
This module provides classes and functions for compressing and decompressing
15+
data using the Zstandard (or *zstd*) compression algorithm. The
16+
`zstd manual <https://facebook.github.io/zstd/doc/api_manual_latest.html>`__
17+
describes Zstandard as "a fast lossless compression algorithm, targeting
18+
real-time compression scenarios at zlib-level and better compression ratios."
19+
Also included is a file interface that supports reading and writing the
20+
contents of ``.zst`` files created by the :program:`zstd` utility, as well as
21+
raw zstd compressed streams.
1922

2023
The :mod:`!compression.zstd` module contains:
2124

0 commit comments

Comments
 (0)