imas_validator.rules.loading.load_docs_from_rule_files¶

imas_validator.rules.loading.load_docs_from_rule_files(result_collector: ResultCollector, validate_options: ValidateOptions, paths: list[Path], show_empty: bool = True) → list[RuleFileData]¶

Load docstrings for several rule files

Parameters:

result_collector: ResultCollector¶

ResultCollector where the found tests will deposit their results after being run

validate_options: ValidateOptions¶

Dataclass for validate options

paths: list[Path]¶

Paths in which validation rules were found

show_empty: bool = True¶

Whether or not to show show empty directories and files

Returns:

List of RuleFileData objects