FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

bpo-45600: Enhanced / clarified the docs for os.environ and os.environb by akulakov · Pull Request #29204 · python/cpython · GitHub

  1. python
  2. cpython

Repository navigation

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

Merged
ambv merged 4 commits into
python:mainfrom
akulakov:45600-Clarify-os.environ-docs
Oct 29, 2021
ConversationCommits (4)ChecksFiles changed
Merged

bpo-45600: Enhanced / clarified the docs for os.environ and os.environb#29204
ambv merged 4 commits into
python:mainfrom
akulakov:45600-Clarify-os.environ-docs

Conversation

akulakov commented Oct 24, 2021 •
edited
Loading

Copy link
Copy Markdown
Contributor

https://bugs.python.org/issue45600

Co-authored by Eryk Sun

bedevere-bot added the docs Documentation in the Doc dir label Oct 24, 2021
ambv reviewed Oct 28, 2021
View reviewed changes
Comment thread 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

ambv Oct 28, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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.

Comment thread 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

ambv Oct 28, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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).

akulakov Oct 28, 2021

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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

ambv reviewed Oct 28, 2021
View reviewed changes
Comment thread Doc/library/os.rst Outdated
Update Doc/library/os.rst
56d7683 
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
ambv merged commit b17cfd1 into python:main Oct 29, 2021

miss-islington commented Oct 29, 2021

Copy link
Copy Markdown
Contributor

Thanks @akulakov for the PR, and @ambv for merging it 🌮🎉.. I'm working now to backport this PR to: 3.9.
🐍🍒⛏🤖

miss-islington commented Oct 29, 2021

Copy link
Copy Markdown
Contributor

Thanks @akulakov for the PR, and @ambv for merging it 🌮🎉.. I'm working now to backport this PR to: 3.10.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 29, 2021
bpo-45600: Enhanced / clarified the docs for os.environ and os.enviro…
1962ebf 
…nb (pythonGH-29204)

Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit b17cfd1)

Co-authored-by: andrei kulakov <andrei.avk@gmail.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 29, 2021
bpo-45600: Enhanced / clarified the docs for os.environ and os.enviro…
d6c5b84 
…nb (pythonGH-29204)

Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit b17cfd1)

Co-authored-by: andrei kulakov <andrei.avk@gmail.com>

bedevere-bot commented Oct 29, 2021

Copy link
Copy Markdown

GH-29321 is a backport of this pull request to the 3.9 branch.

bedevere-bot commented Oct 29, 2021

Copy link
Copy Markdown

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
bpo-45600: Enhanced / clarified the docs for os.environ and os.enviro…
0538351 
…nb (GH-29204) (GH-29322)

Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit b17cfd1)

Co-authored-by: andrei kulakov <andrei.avk@gmail.com>
ambv pushed a commit that referenced this pull request Oct 29, 2021
bpo-45600: Enhanced / clarified the docs for os.environ and os.enviro…
3ec1124 
…nb (GH-29204) (GH-29321)

Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit b17cfd1)

Co-authored-by: andrei kulakov <andrei.avk@gmail.com>

akulakov commented Oct 30, 2021

Copy link
Copy Markdown
Contributor Author

@ambv thanks for reviewing!

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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

ambv ambv left review comments

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

Back | FazBrowse Home | New Git URL