Checker

class markdown_checker.checker.CheckResult(issues=<factory>, links_checked=0)

Bases: object

Result of running a check on one or more files.

Parameters:
issues: list[tuple[Path, list[MarkdownLinkBase]]]
markdown_checker.checker.detect_issues(func, file_path, config)

Detect issues in a single markdown file using the named check.

Args:

func (str): Name of the check to run (must be a key in REGISTRY). file_path (Path): Path to the markdown file to check. config (Config): Runtime configuration for the check.

Returns:

A tuple of (detected_issues, links_checked_count).

Raises:

ValueError: If func is not a registered check name.

Parameters:
Return type:

tuple[list[MarkdownLinkBase], int]

markdown_checker.checker.run_check_on_files(func, files_paths, config, progress_callback)

Run a named check across multiple files.

Args:

func: Name of the check to run (must be a key in REGISTRY). files_paths: List of markdown file paths to check. config: Runtime configuration for the check. progress_callback: Callback invoked after each file is checked.

Returns:

A CheckResult with per-file issues and total links checked.

Parameters:
Return type:

CheckResult