8000 [3.14] gh-132983: Add documentation for compression.zstd (GH-133911) by miss-islington · Pull Request #134425 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

[3.14] gh-132983: Add documentation for compression.zstd (GH-133911) #134425

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.

Sign up for GitHub

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 1 commit into from
May 21, 2025
Merged

[3.14] gh-132983: Add documentation for compression.zstd (GH-133911) #134425

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
gh-132983: Add documentation for compression.zstd (GH-133911) 
Add documentation for compression & compression.zstd.

🎉

---------
(cherry picked from commit d862b6d)

Co-authored-by: Emma Smith <emma@emmatyping.dev>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Co-authored-by: Sumana Harihareswara <sh@changeset.nyc>
Co-authored-by: Martin Panter <vadmium@users.noreply.github.com>
< 8000 ul class="branches-list">
  • Loading branch information
    • @emmatyping @AA-Turner
    @StanFromIreland @hugovk @brainwane @vadmium @miss-islington
    6 people authored and miss-islington committed May 21, 2025
    commit 0fe1a32a7cc04fcceac4cef872497c63400e7601
    4 changes: 3 additions & 1 deletion Doc/library/archiving.rst
    View file
    Open in desktop
    Original file line number Diff line number Diff line change
    Expand Up @@ -5,13 +5,15 @@ Data Compression and Archiving
    ******************************

    The modules described in this chapter support data compression with the zlib,
    gzip, bzip2 and lzma algorithms, and the creation of ZIP- and tar-format
    gzip, bzip2, lzma, and zstd algorithms, and the creation of ZIP- and tar-format
    archives. See also :ref:`archiving-operations` provided by the :mod:`shutil`
    module.


    .. toctree::

    compression.rst
    compression.zstd.rst
    zlib.rst
    gzip.rst
    bz2.rst
    Expand Down
    18 changes: 18 additions & 0 deletions Doc/library/compression.rst
    View file
    Open in desktop
    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.

    * :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

    Loading
    Loading
    0