Skip to content

Commit fc3eb21

Browse files
bskinnCAM-Gerlach
andauthored
PEP 594: Apply typofixes & language tweaks (#2334)
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
1 parent f7bba01 commit fc3eb21

File tree

1 file changed

+23
-20
lines changed

1 file changed

+23
-20
lines changed

pep-0594.rst

+23-20
Original file line numberDiff line numberDiff line change
@@ -267,7 +267,7 @@ The `ossaudiodev <https://docs.python.org/3/library/ossaudiodev.html>`_
267267
module provides support for Open Sound System, an interface to sound
268268
playback and capture devices. OSS was initially free software, but later
269269
support for newer sound devices and improvements were proprietary. Linux
270-
community abandoned OSS in favor of ALSA [1]_. Some operation systems like
270+
community abandoned OSS in favor of ALSA [1]_. Some operating systems like
271271
OpenBSD and NetBSD provide an incomplete [2]_ emulation of OSS.
272272

273273
To best of my knowledge, FreeBSD is the only widespread operating system
@@ -278,7 +278,7 @@ for both FreeBSD community and core development, if the module would be
278278
maintained and distributed by people that care for it and use it.
279279

280280
The standard library used to have more audio-related modules. The other
281-
audio device interface (``audiodev``, ``linuxaudiodev``, ``sunaudiodev``)
281+
audio device interfaces (``audiodev``, ``linuxaudiodev``, ``sunaudiodev``)
282282
were removed in 2007 as part of the :pep:`3108` stdlib re-organization.
283283

284284

@@ -396,8 +396,8 @@ activity since 2014. This is a good indicator that the public interest in
396396
NNTP support is declining.
397397

398398
The ``nntplib`` tests have been the cause of additional work in the recent
399-
past. Python only contains client side of NNTP. The tests connect to
400-
external news server. The servers are sometimes unavailable, too slow, or do
399+
past. Python only contains the client side of NNTP, so the tests connect to
400+
external news servers. The servers are sometimes unavailable, too slow, or do
401401
not work correctly over IPv6. The situation causes flaky test runs on
402402
buildbots.
403403

@@ -418,7 +418,7 @@ crypt
418418
The `crypt <https://docs.python.org/3/library/crypt.html>`_ module implements
419419
password hashing based on the ``crypt(3)`` function from ``libcrypt`` or
420420
``libxcrypt`` on Unix-like platforms. The algorithms are mostly old, of poor
421-
quality and insecure. Users are discouraged to use them.
421+
quality and insecure. Users are discouraged from using them.
422422

423423
* The module is not available on Windows. Cross-platform applications need
424424
an alternative implementation anyway.
@@ -433,18 +433,18 @@ quality and insecure. Users are discouraged to use them.
433433
* The module was never useful to interact with system user and password
434434
databases. On BSD, macOS, and Linux, all user authentication and
435435
password modification operations must go through PAM (pluggable
436-
authentication module), see `spwd`_ deprecation.
436+
authentication module); see the `spwd`_ deprecation.
437437

438438

439439
nis
440440
~~~
441441

442442
The `nis <https://docs.python.org/3/library/nis.html>`_ module provides
443443
NIS/YP support. Network Information Service / Yellow Pages is an old and
444-
deprecated directory service protocol developed by Sun Microsystems. It's
444+
deprecated directory service protocol developed by Sun Microsystems. Its
445445
designed successor NIS+ from 1992 never took off. For a long time, libc's
446-
Name Service Switch, LDAP, and Kerberos/GSSAPI are considered a more powerful
447-
and more secure replacement of NIS.
446+
Name Service Switch, LDAP, and Kerberos/GSSAPI have been considered a more powerful
447+
and more secure replacement for NIS.
448448

449449

450450
spwd
@@ -453,13 +453,13 @@ spwd
453453
The `spwd <https://docs.python.org/3/library/spwd.html>`_ module provides
454454
direct access to Unix shadow password database using non-standard APIs.
455455

456-
In general it's a bad idea to use spwd. It circumvents system
456+
In general, it's a bad idea to use ``spwd``. It circumvents system
457457
security policies, does not use the PAM stack, and is only compatible
458458
with local user accounts, because it ignores NSS. The use of the ``spwd``
459459
module for access control must be considered a *security bug*, as it bypasses
460460
PAM's access control.
461461

462-
Further more the ``spwd`` module uses the
462+
Furthermore, the ``spwd`` module uses the
463463
`shadow(3) <http://man7.org/linux/man-pages/man3/shadow.3.html>`_ APIs.
464464
Functions like ``getspnam(3)`` access the ``/etc/shadow`` file directly. This
465465
is dangerous and even forbidden for confined services on systems with a
@@ -481,7 +481,7 @@ module is used to facilitate distutils to create MSI installers with the
481481
Windows installer, too.
482482

483483
Microsoft is slowly moving away from MSI in favor of Windows 10 Apps (AppX)
484-
as new deployment model [3]_.
484+
as a new deployment model [3]_.
485485

486486

487487
pipes
@@ -490,13 +490,14 @@ pipes
490490
The `pipes <https://docs.python.org/3/library/pipes.html>`_ module provides
491491
helpers to pipe the input of one command into the output of another command.
492492
The module is built on top of ``os.popen``. Users are encouraged to use
493-
the subprocess module instead.
493+
the ``subprocess`` module instead.
494494

495495

496496
Modules to keep
497497
===============
498498

499-
Some modules were originally proposed for deprecation.
499+
Some modules were originally proposed for deprecation but are no longer
500+
listed as such in this PEP.
500501

501502
.. csv-table:: Table 2: Withdrawn deprecations
502503
:header: "Module", "Deprecated in", "Replacement"
@@ -530,8 +531,8 @@ fileinput
530531

531532
The `fileinput <https://docs.python.org/3/library/fileinput.html>`_ module
532533
implements helpers to iterate over a list of files from ``sys.argv``. The
533-
module predates the ``optparser`` and ``argparser`` modules. The same functionality
534-
can be implemented with the ``argparser`` module.
534+
module predates the ``optparse`` and ``argparse`` modules. The same functionality
535+
can be implemented with the ``argparse`` module.
535536

536537
Several core developers expressed their interest to keep the module in the
537538
standard library, as it is handy for quick scripts.
@@ -580,7 +581,7 @@ Discussions
580581
===========
581582

582583
* Elana Hashman and Nick Coghlan suggested to keep the ``getopt`` module.
583-
* Berker Peksag proposed to deprecate and removed ``msilib``.
584+
* Berker Peksag proposed to deprecate and remove ``msilib``.
584585
* Brett Cannon recommended to delay active deprecation warnings and removal
585586
of modules like ``imp`` until Python 3.10. Version 3.8 will be released
586587
shortly before Python 2 reaches end-of-life. A delay reduced churn for
@@ -597,7 +598,7 @@ Discussions
597598
stdlib doesn't have a replacement for the servers, yet.
598599

599600

600-
Rejected Ideas
601+
Rejected ideas
601602
==============
602603

603604
Creating/maintaining a separate repo for the deprecated modules
@@ -619,7 +620,7 @@ Update history
619620
Update 1
620621
--------
621622

622-
* Deprecate parser module
623+
* Deprecate ``parser`` module
623624
* Keep `fileinput`_ module
624625
* Elaborate why ``crypt`` and ``spwd`` are dangerous and bad
625626
* Improve sections for `cgitb`_, `colorsys`_, `nntplib`_, and `smtpd`_ modules
@@ -637,18 +638,20 @@ Update 2
637638
* Add experts
638639
* Redirect discussions to discuss.python.org
639640
* Deprecate `telnetlib`_
640-
* Deprecate compat32 policy of email package
641+
* Deprecate compat32 policy of ``email`` package
641642
* Add creation year to overview table
642643
* Mention :pep:`206` and :pep:`3108`
643644
* Update sections for ``aifc``, ``audioop``, ``cgi``, and ``wave``.
644645

645646
Update 3
646647
--------
648+
647649
* Keep the legacy email API modules. Internal deprecations will be
648650
handled separately.
649651

650652
Update 4
651653
--------
654+
652655
* Add Brett as a co-author.
653656
* Retarget the PEP for Python 3.11.
654657
* Examples of how to replace the relevant parts of ``cgi``

0 commit comments

Comments
 (0)