Skip to content

Gh issue 3456 update environment variable documentation #3482

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 2 commits into from
Feb 15, 2025
Merged

Gh issue 3456 update environment variable documentation #3482

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
31c31a3
Fix typos
jugmac00 Feb 15, 2025
a47504e
Fix docs for retrieving missing environment variable.
jugmac00 Feb 15, 2025
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
1 change: 1 addition & 0 deletions docs/changelog/3456.doc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Updates the documentation for ``os.environ['KEY']`` when the variable does not exist - by :user:`jugmac00`.
7 changes: 4 additions & 3 deletions docs/config.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1635,7 +1635,8 @@ If you specify a substitution string like this::

{env:KEY}

then the value will be retrieved as ``os.environ['KEY']`` and raise an Error if the environment variable does not exist.
then the value will be retrieved as ``os.environ['KEY']`` and replaced with an empty string if the environment variable
does not exist.


Environment variable substitutions with default values
Expand All @@ -1645,14 +1646,14 @@ If you specify a substitution string like this::

{env:KEY:DEFAULTVALUE}

then the value will be retrieved as ``os.environ['KEY']`` and replace with DEFAULTVALUE if the environment variable does
then the value will be retrieved as ``os.environ['KEY']`` and replaced with DEFAULTVALUE if the environment variable does
not exist.

If you specify a substitution string like this::

{env:KEY:}

then the value will be retrieved as ``os.environ['KEY']`` and replace with an empty string if the environment variable
then the value will be retrieved as ``os.environ['KEY']`` and replaced with an empty string if the environment variable
does not exist.

Substitutions can also be nested. In that case they are expanded starting from the innermost expression::
Expand Down