-
-
Notifications
You must be signed in to change notification settings - Fork 32k
gh-132983: Add documentation for compression.zstd #133911
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
23 commits
Select commit
Hold shift + click to select a range
49d9c30
Add documentation for compression.zstd
emmatyping 62ef4dc
Add examples
emmatyping 0b154b1
Fix camelcase name references
emmatyping 63f963f
CParameter->CompressionParameter
emmatyping cfe0590
Apply suggestions from AA-Turner
emmatyping 5115b4c
Apply suggestions from reviewers
emmatyping 4ab7fd7
Apply suggestions from reviewers
emmatyping 5eb5efc
Apply suggestions from reviewers
emmatyping 987bd27
Don't reference self when referring to items
emmatyping 615ed7f
Updates to respond to review
emmatyping 0f7bc05
Remove outdated paragraph
emmatyping 44173f3
Remove Zstandard dictionary after ZstdDict
emmatyping 8bd5500
Rewrite introduction to compression package to be more timeless
emmatyping 24f3761
Remove content_size_flag
emmatyping d04ce4f
Merge branch 'zstd-docs' of github.com:emmatyping/cpython into zstd-docs
emmatyping e61e9a1
Apply suggestions from Sumana and Stan
emmatyping 1149832
Remove ref to Meta and clean up mode usage
emmatyping 71ed7c3
Apply suggestions from vadmium
emmatyping 2f895dd
Many updates to respond to review
emmatyping f25e6e7
Add examples to (De)compressionParameter
emmatyping 9ff6320
Add reference to zstd manual and blurb on algorithm
emmatyping daa9df1
Expand on the connection between level and compression_level
emmatyping b3fd3cd
Resolve review suggestions
emmatyping File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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,18 @@ | ||
The :mod:`!compression` package | ||
=============================== | ||
|
||
.. versionadded:: 3.14 | ||
|
||
The :mod:`!compression` package contains the canonical compression modules | ||
containing interfaces to several different compression algorithms. Some of | ||
these modules have historically been available as separate modules; those will | ||
continue to be available under their original names for compatibility reasons, | ||
and will not be removed without a deprecation cycle. The use of modules in | ||
:mod:`!compression` is encouraged where practical. | ||
emmatyping marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
* :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 | ||
|
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.
Uh oh!
There was an error while loading. Please reload this page.