Gh issue 3456 update environment variable documentation (#3482)

* Fix typos * Fix docs for retrieving missing environment variable. Fixes #3456
tox-dev · Feb 15, 2025 · 65d404e · 65d404e
1 parent 28212ab
commit 65d404e
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/docs/changelog/3456.doc.rst b/docs/changelog/3456.doc.rst
@@ -0,0 +1 @@
+Updates the documentation for ``os.environ['KEY']`` when the variable does not exist - by :user:`jugmac00`.
diff --git a/docs/config.rst b/docs/config.rst
@@ -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
@@ -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::
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`.