@@ -26,7 +26,7 @@ To use your configuration file, follow these steps one time:
2626
2727.. _config-key-naming-conventions :
2828
29- Key Naming conventions
29+ Key Naming Conventions
3030----------------------
3131
3232The keys follow specific naming conventions to indicate their purpose and expected value types. Here are some common patterns whereas the asterisk
@@ -60,7 +60,9 @@ The validation checks for different aspects of the configuration, such as:
6060* Correct use of placeholders.
6161
6262
63- .. TODO: Add a link to the TOML env config reference, add an example of
63+ ..
64+ TODO: Add a link to the TOML env config reference, add an example of
65+ a validation error message, and explain how to fix common issues.
6466 a validation error message, and explain how to fix common issues.
6567
6668
@@ -92,7 +94,7 @@ Static placeholders follow a specific syntax:
9294
9395* **Regular name ** (Syntax ``{placeholder} ``)
9496
95- A regular name refers to a another key in the same section:
97+ A regular name refers to another key in the same section:
9698
9799 .. code-block :: toml
98100 :emphasize-lines: 3
@@ -115,15 +117,16 @@ Static placeholders follow a specific syntax:
115117 [server]
116118 name = "doc-example-com"
117119
118- [path]
120+ [paths]
121+ base_cache_dir = "/tmp/cache"
122+ base_server_cache_dir = "{base_cache_dir}/{server.name}"
119123 base_server_cache_dir = "{base_cache_dir}/{server.name}"
120124
121125 In this example, the key ``base_server_cache_dir `` uses the
122126 static placeholder ``{server.name} `` to reference the value of the
123127 key ``name `` in the ``server `` section.
124128
125- If you have nested sections, use the dot notation to reference the keys.
126- For example, ``section.subsection.key ``.
129+ If you have nested sections, use dot notation to reference the keys (for example, ``section.subsection.key ``).
127130
128131
129132.. _config-viewing-docbuild-config-env :
0 commit comments