From 5d44f274d1c21d9c313d93cd97d7e4d85c91ee13 Mon Sep 17 00:00:00 2001
From: Gerrit Holl <gerrit.holl@dwd.de>
Date: Tue, 21 Jan 2025 10:45:34 +0100
Subject: [PATCH] Clarify satpy.yaml use with nested dictionaries

---
 doc/source/config.rst | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/doc/source/config.rst b/doc/source/config.rst
index 1cbbbec2ed..19feb6bd8f 100644
--- a/doc/source/config.rst
+++ b/doc/source/config.rst
@@ -51,7 +51,11 @@ value. For example:
 
     cache_dir: "/tmp"
     data_dir: "/tmp"
+    readers:
+      clip_negative_radiances: True
 
+Note that a dotted configuration key (such as ``readers.clip_negative_radiances``)
+should be written into ``satpy.yaml`` as a nested dictionary, such as in the example above.
 Lastly, it is possible to specify an additional config path to the above
 options by setting the environment variable ``SATPY_CONFIG``. The file
 specified with this environment variable will be added last after all of the