Skip to content
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

Jump to bottom

gh-83940: Remove os.env/b default type constraint in os docs #98113

Merged
merged 2 commits into from
Oct 10, 2022
Merged

gh-83940: Remove os.env/b default type constraint in os docs #98113

merged 2 commits into from
Oct 10, 2022

Conversation

slateny
Copy link
Contributor

@slateny slateny commented Oct 9, 2022 •
edited by bedevere-bot
Loading

@bedevere-bot bedevere-bot added awaiting review docs Documentation in the Doc dir skip news labels Oct 9, 2022
@slateny slateny mentioned this pull request Oct 9, 2022
Closed
JelleZijlstra
JelleZijlstra reviewed Oct 10, 2022
View reviewed changes
Doc/library/os.rst Outdated
@@ -305,7 +305,7 @@ 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
*default* if it doesn't. *key* and the result are strings. Note that
Copy link
Member

Choose a reason for hiding this comment

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

The result isn't a string if default isn't one. I'd suggest "Return the value of the environment variable key as a string if it exists, or default if it doesn't. key is a string."

@JelleZijlstra JelleZijlstra added needs backport to 3.10 only security fixes needs backport to 3.11 only security fixes labels Oct 10, 2022
@JelleZijlstra JelleZijlstra merged commit 187e853 into python:main Oct 10, 2022
@miss-islington
Copy link
Contributor

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

@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label Oct 10, 2022
@bedevere-bot
Copy link

GH-98149 is a backport of this pull request to the 3.11 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.10 only security fixes label Oct 10, 2022
@bedevere-bot
Copy link

GH-98150 is a backport of this pull request to the 3.10 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 10, 2022
@slateny @miss-islington
pythongh-83940: os docs: Improve wording for getenv/getenvb (pythonGH…
fa1043e 
…-98113)

(cherry picked from commit 187e853)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 10, 2022
@slateny @miss-islington
pythongh-83940: os docs: Improve wording for getenv/getenvb (pythonGH…
8a48d2c 
…-98113)

(cherry picked from commit 187e853)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
miss-islington added a commit that referenced this pull request Oct 10, 2022
@miss-islington @slateny
gh-83940: os docs: Improve wording for getenv/getenvb (GH-98113)
fc14f1a 
(cherry picked from commit 187e853)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
miss-islington added a commit that referenced this pull request Oct 10, 2022
@miss-islington @slateny
gh-83940: os docs: Improve wording for getenv/getenvb (GH-98113)
de74587 
(cherry picked from commit 187e853)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
@slateny slateny deleted the s/83940 branch October 10, 2022 19:45
mpage pushed a commit to mpage/cpython that referenced this pull request Oct 11, 2022
@slateny @mpage
pythongh-83940: os docs: Improve wording for getenv/getenvb (python#9…
70a2708 
…8113)
pablogsal pushed a commit that referenced this pull request Oct 22, 2022
@miss-islington @slateny @pablogsal
gh-83940: os docs: Improve wording for getenv/getenvb (GH-98113)
1f58d8c 
(cherry picked from commit 187e853)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
@jiridanek jiridanek mentioned this pull request Jan 2, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JelleZijlstra JelleZijlstra JelleZijlstra approved these changes

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.
4 participants
@slateny @miss-islington @bedevere-bot @JelleZijlstra