]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
bpo-45600: Enhanced / clarified the docs for os.environ and os.environb (GH-29204...
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Fri, 29 Oct 2021 20:52:59 +0000 (13:52 -0700)
committerGitHub <noreply@github.com>
Fri, 29 Oct 2021 20:52:59 +0000 (22:52 +0200)
Co-authored-by: Ɓukasz Langa <lukasz@langa.pl>
(cherry picked from commit b17cfd150f4dc2816975d304a71110a2d445eaf0)

Co-authored-by: andrei kulakov <andrei.avk@gmail.com>
Doc/library/os.rst

index 23e220c009d307efa3036f3c3a3bed72ece7505a..d4cc296fbf89af024643057c5e237c5ba15b4626 100644 (file)
@@ -102,9 +102,10 @@ process and user.
 
 .. data:: environ
 
-   A :term:`mapping` object representing the string environment. For example,
-   ``environ['HOME']`` is the pathname of your home directory (on some platforms),
-   and is equivalent to ``getenv("HOME")`` in C.
+   A :term:`mapping` object where keys and values are strings that represent
+   the process environment.  For example, ``environ['HOME']`` is the pathname
+   of your home directory (on some platforms), and is equivalent to
+   ``getenv("HOME")`` in C.
 
    This mapping is captured the first time the :mod:`os` module is imported,
    typically during Python startup as part of processing :file:`site.py`.  Changes
@@ -141,10 +142,10 @@ process and user.
 
 .. data:: environb
 
-   Bytes version of :data:`environ`: a :term:`mapping` object representing the
-   environment as byte strings. :data:`environ` and :data:`environb` are
-   synchronized (modify :data:`environb` updates :data:`environ`, and vice
-   versa).
+   Bytes version of :data:`environ`: a :term:`mapping` object where both keys
+   and values are :class:`bytes` objects representing the process environment.
+   :data:`environ` and :data:`environb` are synchronized (modifying
+   :data:`environb` updates :data:`environ`, and vice versa).
 
    :data:`environb` is only available if :data:`supports_bytes_environ` is
    ``True``.