Update docs on nested (dotted) keys (#113)

* Update docs on nested keys, which are allowed now * Update CHANGES
uwefladrich · Feb 21, 2024 · 4f3b7b9 · 4f3b7b9
1 parent 7f36739
commit 4f3b7b9
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/CHANGES.txt b/CHANGES.txt
@@ -4,6 +4,7 @@ Next release
 Features
 --------
 - #112: Rename base.context.from to base.context.load
+- #113: Update docs on nested (dotted) keys
 
 Fixes
 -----

diff --git a/docs/sphinx/base-tasks.rst b/docs/sphinx/base-tasks.rst
@@ -106,7 +106,7 @@ This feature allows a shorter notation wherever context parameters are accessed
 by their names.
 
 .. versionadded:: 1.0
-    Dotted key access.
+    Allow for dotted keys for nested context parameters.
 
 
 ``base.context.load``
@@ -297,9 +297,8 @@ for example::
 When a requested environment variable does not exist, a warning is given and no
 corresponding context changes are made.
 
-.. warning::
-   Only simple, non-nested context parameters (without dots) can be used in
-   ``base.getenv``
+.. versionadded:: 1.0
+   Allow dotted keys for nested context parameters.
 
 
 ``base.setenv``
@@ -328,8 +327,8 @@ will set the environment variables ``$LD_LIBRARY_PATH`` to
    converted to the string ``"1"`` before it is assigned to the environment
    variable ``$FOO``.
 
-.. warning::
-   Only simple, non-nested context parameters can be used in ``base.setenv``
+.. versionadded:: 1.0
+   Allow dotted keys for nested context parameters.
 
 
 Basic file operations
-Original file line number
+Diff line change
@@ Expand Up / @@ -4,6 +4,7 @@ Next release @@
     Features
     --------
     - #112: Rename base.context.from to base.context.load
+    - #113: Update docs on nested (dotted) keys
     Fixes
     -----
@@ Expand Down @@