docs: add vars/gaph doc-strings

This commit is contained in:
Johannes Kirschbauer
2025-07-31 15:24:59 +02:00
parent d19ac1b9f5
commit e2e4837b29

View File

@@ -80,11 +80,22 @@ def toposort_closure(
# all generators in topological order
def full_closure(generators: dict[str, Generator]) -> list[Generator]:
"""
From a set of generators, return all generators in topological order.
This includes all dependencies and dependents of the generators.
Returns all generators in topological order.
"""
return toposort_closure(generators.keys(), generators)
# just the missing generators including their dependents
def all_missing_closure(generators: dict[str, Generator]) -> list[Generator]:
"""
From a set of generators, return all incomplete generators in topological order.
incomplete
: A generator is missing if at least one of its files is missing.
"""
# collect all generators that are missing from disk
closure = {gen_name for gen_name, gen in generators.items() if not gen.exists}
closure = add_dependents(closure, generators)