Skip to content

Commit d4db252

Browse files
committed
document configuration fixture coverage
1 parent 6c3d8dd commit d4db252

1 file changed

Lines changed: 8 additions & 3 deletions

File tree

crates/api-core/src/test_support/default_config.rs

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -103,9 +103,14 @@ pub(crate) fn with_dpf_intercept_topology(selected_vfs: &[u8]) -> CarbideConfig
103103

104104
/// [`get`] with every `Option` config section populated. Used by tests that
105105
/// walk the *serialized* config shape — e.g. the admin-UI documentation
106-
/// guards, which can only verify sections that actually serialize. When a
107-
/// new `Option` section is added to [`CarbideConfig`] (the compiler forces
108-
/// it into [`get`]), populate it here too so those guards can see inside it.
106+
/// guards, which can only verify sections and fields that actually serialize.
107+
/// When a new `Option` section is added to [`CarbideConfig`] (the compiler
108+
/// forces it into [`get`]), populate it here too. The
109+
/// `fmds_use_node_tokens` inner `Option` below is populated so its documented
110+
/// row is covered. New `skip_serializing_if` fields need the same explicit
111+
/// treatment when they should be checked; this is not compiler-enforced.
112+
/// `mlxconfig_profiles` is intentionally exempted by `SKIP_SERIALIZING` in
113+
/// `crates/api-web/src/configuration.rs`.
109114
pub fn fully_populated() -> CarbideConfig {
110115
CarbideConfig {
111116
auth: Some(AuthConfig {

0 commit comments

Comments
 (0)