Skip to content

Commit c4f9d7d

Browse files
committed
Minor formatating and wording improvements
1 parent f4ba4c5 commit c4f9d7d

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

peps/pep-0784.rst

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -316,8 +316,8 @@ development window. However, introducing a private module was not popular. The
316316
expectations and contract for external usage of a private module in the
317317
standard library are unclear.
318318

319-
Name the module ``std.zstd`` or some other standard library namespace
320-
---------------------------------------------------------------------
319+
Introduce a standard library namespace instead of ``compression``
320+
-----------------------------------------------------------------
321321

322322
One alternative to a ``compression`` namespace would be to introduce a
323323
``std`` namespace for the entire standard library. However, this was seen as
@@ -329,11 +329,13 @@ into the ``std`` namespace.
329329
Include ``zipfile`` and ``tarfile`` in ``compression``
330330
------------------------------------------------------
331331

332-
Compression is often used with archiving tools, so putting both ``zipfile`` and
333-
``tarfile`` under the ``compression`` namespace is appealing. However,
332+
Compression is often used with archiving tools, so putting both :mod:`zipfile`
333+
and :mod:`tarfile` under the ``compression`` namespace is appealing. However,
334334
compression can be used beyond just archiving tools. For example, network
335335
requests can be gzip compressed. Furthermore, formats like tar do not include
336-
compression themselves, instead relying on external compression.
336+
compression themselves, instead relying on external compression. Therefore,
337+
this PEP does not propose moving :mod:`!zipfile` or :mod:`!tarfile` under
338+
``compression``.
337339

338340
Do not include ``gzip`` under ``compression``
339341
---------------------------------------------
@@ -349,7 +351,7 @@ compression format and not an archiving format.
349351
Language Compression or Archive Documentation Link
350352
========== ======================== ==============================================================================
351353
Golang Compression https://pkg.go.dev/compress/gzip
352-
Ruby Compression https://docs.ruby-lang.org/en//master/Zlib/GzipFile.html
354+
Ruby Compression https://docs.ruby-lang.org/en/master/Zlib/GzipFile.html
353355
Rust Compression https://github.com/rust-lang/flate2-rs
354356
Haskell Compression https://hackage.haskell.org/package/zlib
355357
C# Compression https://learn.microsoft.com/en-us/dotnet/api/system.io.compression.gzipstream

0 commit comments

Comments
 (0)