[Python-checkins] gh-83940: os docs: Improve wording for getenv/getenvb (GH-98113)

miss-islington webhook-mailer at python.org
Mon Oct 10 10:01:23 EDT 2022


https://github.com/python/cpython/commit/de745870e600e38fe7c753c461d22e9debad7f66
commit: de745870e600e38fe7c753c461d22e9debad7f66
branch: 3.10
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: miss-islington <31488909+miss-islington at users.noreply.github.com>
date: 2022-10-10T07:01:17-07:00
summary:

gh-83940: os docs: Improve wording for getenv/getenvb (GH-98113)

(cherry picked from commit 187e853690908ca2af19a0701ca7529b43d05df9)

Co-authored-by: Stanley <46876382+slateny at users.noreply.github.com>

files:
M Doc/library/os.rst

diff --git a/Doc/library/os.rst b/Doc/library/os.rst
index 58f01e97459c..8753132429d6 100644
--- a/Doc/library/os.rst
+++ b/Doc/library/os.rst
@@ -291,8 +291,8 @@ process and user.
 
 .. function:: getenv(key, default=None)
 
-   Return the value of the environment variable *key* if it exists, or
-   *default* if it doesn't. *key*, *default* and the result are str. Note that
+   Return the value of the environment variable *key* as a string if it exists, or
+   *default* if it doesn't. *key* is a string. Note that
    since :func:`getenv` uses :data:`os.environ`, the mapping of :func:`getenv` is
    similarly also captured on import, and the function may not reflect
    future environment changes.
@@ -306,8 +306,8 @@ process and user.
 
 .. function:: getenvb(key, default=None)
 
-   Return the value of the environment variable *key* if it exists, or
-   *default* if it doesn't. *key*, *default* and the result are bytes. Note that
+   Return the value of the environment variable *key* as bytes if it exists, or
+   *default* if it doesn't. *key* must be bytes. Note that
    since :func:`getenvb` uses :data:`os.environb`, the mapping of :func:`getenvb` is
    similarly also captured on import, and the function may not reflect
    future environment changes.



More information about the Python-checkins mailing list