Skip to content

bpo-45600: Enhanced / clarified the docs for os.environ and os.environb #29204

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 4 commits into from
Oct 29, 2021
Merged

bpo-45600: Enhanced / clarified the docs for os.environ and os.environb #29204

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fe20fa4
Enhanced / clarified the docs for os.environ and os.environb
akulakov Oct 24, 2021
b674072
update wording
akulakov Oct 28, 2021
2947b2a
add "both"
akulakov Oct 28, 2021
56d7683
Update Doc/library/os.rst
akulakov Oct 28, 2021
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
14 changes: 7 additions & 7 deletions Doc/library/os.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,9 +170,9 @@ 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 of key and value strings that represent the process
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This isn't valid English. You want to say "of string keys and values", or less tersely "where keys and values are strings" which I think reads better.

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
Expand Down Expand Up @@ -209,10 +209,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 of key and value
byte strings representing the process environment. :data:`environ` and
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Similarly, here you can say "where both keys and values are :class:bytes objects" (we avoid saying "byte strings" now, there is only a few cases of this left in the entire documentation).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like "keys and values are strings", updated.

:data:`environb` are synchronized (modify :data:`environb` updates
:data:`environ`, and vice versa).

:data:`environb` is only available if :data:`supports_bytes_environ` is
``True``.
Expand Down