main: further document get_rules

This commit is contained in:
Willi Ballenthin
2023-01-21 19:24:20 +01:00
parent f152729c79
commit a076a0c44e

View File

@@ -613,6 +613,9 @@ def get_rules(
"""
args:
rule_paths: list of paths to rules files or directories containing rules files
disable_progress: disable progress bar
cache_dir: directory to use for caching rules, or will use the default detected cache directory if None
on_load_rule: callback to invoke before a rule is loaded, use for progress or cancellation
"""
if cache_dir is None:
cache_dir = capa.rules.cache.get_default_cache_directory()