Checks#

class gh_issue_validator.checks.ValidationCheck[source]#
abstractmethod check(*, segments, report)[source]#

Apply the check to the document and report issues.

Parameters:
Return type:

None

class gh_issue_validator.checks.Validator(*, checks)[source]#

Entrypoint for registering and executing checks on a Markdown document.

Parameters:

checks (list[ValidationCheck])

validate(*, markdown)[source]#

Run all validation checks on markdown.

Parameters:

markdown (str)

Return type:

ValidationReport