bpo-45600: Enhanced / clarified the docs for os.environ and os.environb #29204
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ambv
reviewed
Oct 28, 2021
Doc/library/os.rst
Outdated
| 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 |
There was a problem hiding this comment.
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.
Doc/library/os.rst
Outdated
Comment on lines
212
to
213
| Bytes version of :data:`environ`: a :term:`mapping` object of key and value | ||
| byte strings representing the process environment. :data:`environ` and |
There was a problem hiding this comment.
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).
There was a problem hiding this comment.
I like "keys and values are strings", updated.
ambv
reviewed
Oct 28, 2021
Co-authored-by: Łukasz Langa <[email protected]>
ambv
added
needs backport to 3.9
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Oct 29, 2021
…nb (pythonGH-29204) Co-authored-by: Łukasz Langa <[email protected]> (cherry picked from commit b17cfd1) Co-authored-by: andrei kulakov <[email protected]>
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Oct 29, 2021
…nb (pythonGH-29204) Co-authored-by: Łukasz Langa <[email protected]> (cherry picked from commit b17cfd1) Co-authored-by: andrei kulakov <[email protected]>
|
GH-29321 is a backport of this pull request to the 3.9 branch. |
|
GH-29322 is a backport of this pull request to the 3.10 branch. |
ambv
pushed a commit
that referenced
this pull request
Oct 29, 2021
…nb (GH-29204) (GH-29322) Co-authored-by: Łukasz Langa <[email protected]> (cherry picked from commit b17cfd1) Co-authored-by: andrei kulakov <[email protected]>
ambv
pushed a commit
that referenced
this pull request
Oct 29, 2021
…nb (GH-29204) (GH-29321) Co-authored-by: Łukasz Langa <[email protected]> (cherry picked from commit b17cfd1) Co-authored-by: andrei kulakov <[email protected]>
|
@ambv thanks for reviewing! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
https://bugs.python.org/issue45600
Co-authored by Eryk Sun