gh-132983: Add documentation for compression.zstd #133911
+796
−1
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,25 @@ | ||||||||||||||||||||||||||||||
| The :mod:`!compression` package | ||||||||||||||||||||||||||||||
| ================================= | ||||||||||||||||||||||||||||||
|
Comment on lines
+1
to
+2
There was a problem hiding this comment.
Suggested change
|
||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| .. versionadded:: 3.14 | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| .. note:: | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| Several modules in :mod:`!compression` re-export modules that currently | ||||||||||||||||||||||||||||||
| exist at the repository top-level. These re-exported modules are the new | ||||||||||||||||||||||||||||||
| canonical import name for the respective top-level module. The existing | ||||||||||||||||||||||||||||||
| modules are not currently deprecated and will not be removed prior to Python | ||||||||||||||||||||||||||||||
| 3.19, but users are encouraged to migrate to the new import names when | ||||||||||||||||||||||||||||||
| feasible. | ||||||||||||||||||||||||||||||
|
Comment on lines
+6
to
+13
There was a problem hiding this comment.
Suggested change
|
||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| * :mod:`!compression.bz2` -- Re-exports :mod:`bz2` | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| * :mod:`!compression.gzip` -- Re-exports :mod:`gzip` | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| * :mod:`!compression.lzma` -- Re-exports :mod:`lzma` | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| * :mod:`!compression.zlib` -- Re-exports :mod:`zlib` | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| * :mod:`compression.zstd` -- Wrapper for the Zstandard compression library | ||||||||||||||||||||||||||||||
|
Comment on lines
+15
to
+23
There was a problem hiding this comment.
Suggested change
|
||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
New algorithm at the end?