You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/developer/meta/config-specs.md
+8-2Lines changed: 8 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -134,8 +134,14 @@ It respects a few extra [option](#options)-level attributes:
134
134
135
135
It also respects a few extra fields under the `value` attribute of each option:
136
136
137
-
- `display_default`- This is the default value that will be shown in the header of each option, useful if it differs from the `example`.
138
-
This will take precedence over the `default`. You may also set it to `null` explicitly to disable showing this part of the header.
137
+
- `display_default`- Overrides the default value shown in the commented-out header of the example file. This is useful if the value you want to *display* differs from the `example` value or the functional `default` value.
138
+
139
+
* **Value Precedence:** When generating the header, the consumer displays the *first* value it finds from this priority list:
140
+
1. `display_default`
141
+
2. `default` (from the [Data model consumer](#data-model-consumer))
142
+
3. `example` (from the [Values](#values) section)
143
+
144
+
* **Suppressing the Default:** To explicitly *prevent* any default value from being shown in the header, set this field to `null`. This will suppress the output even if `default` or `example` are set.
139
145
- `compact_example`- Whether or not to display complex types like arrays in their most compact representation. It defaults to `false`.
0 commit comments