Clarify satpy.yaml use with nested dictionaries

pytroll · Jan 21, 2025 · 5d44f27 · 5d44f27
1 parent 6fc15fe
commit 5d44f27
Showing 1 changed file with 4 additions and 0 deletions.
diff --git 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