Skip to content

Commit 689a3df

Browse files
committed
chore: comments
1 parent 936bc24 commit 689a3df

File tree

1 file changed

+13
-5
lines changed
  • rust/signed_doc/src/validator/rules/parameters

1 file changed

+13
-5
lines changed

rust/signed_doc/src/validator/rules/parameters/mod.rs

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -177,11 +177,11 @@ impl ParametersRule {
177177
}
178178
}
179179

180-
/// Performs a parameter link validation between a given reference field and the expected
181-
/// parameters.
180+
/// Validates that all documents referenced by `ref_field` recursively contain
181+
/// `parameters` matching the expected `exp_parameters`.
182182
///
183-
/// Validates that all referenced documents
184-
/// have matching `parameters` with the current document's expected `exp_parameters`.
183+
/// The check expands each referenced document's parameter chain and succeeds
184+
/// if any discovered parameter set equals `exp_parameters`.
185185
///
186186
/// # Returns
187187
/// - `Ok(true)` if:
@@ -238,7 +238,15 @@ where
238238
Ok(all_valid)
239239
}
240240

241-
/// Recursively collects the full underlying parameters from a given document reference.
241+
/// Recursively traverses the parameter chain starting from `root`,
242+
/// collecting all discovered `parameters` sets.
243+
///
244+
/// Returns:
245+
/// - `(true, set)` if all referenced documents are retrievable.
246+
/// - `(false, set)` if any underlying document cannot be fetched.
247+
///
248+
/// All encountered parameter lists are returned; traversal is cycle-safe
249+
/// and explores deeper parameter references recursively.
242250
async fn collect_parameters_recursively<Provider>(
243251
root: &DocumentRef,
244252
field_name: &str,

0 commit comments

Comments
 (0)