imas_validator.rules.loading.load_docs¶

imas_validator.rules.loading.load_docs(result_collector: ResultCollector, validate_options: ValidateOptions, show_empty: bool = False) → ExplorerData¶

Load docstrings for several rule dirs

Parameters:

result_collector: ResultCollector¶

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

validate_options: ValidateOptions¶

Dataclass for validate options

show_empty: bool = False¶

Whether or not to show show empty directories and files

Returns:

ExploreData object with doctstrings and rule directory structure