Known CNS errors

Detect known/common CNS errors.

Inspired from: https://github.com/haddocking/haddock25/blob/main/tools/check-error-messages.sh

haddock.gear.known_cns_errors.find_all_cns_errors(directory_path: str | Path) → dict[str, dict[str, int | KnownCNSError]]

Find all errors in a directory.

Parameters:

directory_path (FilePath) – Path to the directory to be checked.

Returns:

all_errors (dict[str, dict[str, Union[list[FilePath], KnownCNSError]]]) – Dictionary containing all errors found in this directory.

haddock.gear.known_cns_errors.find_cns_errors(cns_out_fpath: str | Path) → KnownCNSError | None

Detect if a known CNS error is in a cns.cnserr file.

Parameters:

cns_out_fpath (FilePath -> Union[str, Path]) – Path to the cns.cnserr file to check.

Returns:

Optional[KnownCNSError] – An exception for known CNS errors, with its hint on how to solve it!