RM005

class src.ansys.pre_commit_hooks.quality_rules.readme.RM005

Bases: README

README has an installation section.

Requires a heading that contains install, such as Installation or How to install. Either a Markdown # heading or an underlined reStructuredText heading is accepted. The word in body text or in a URL does not count.

Notes

• A missing heading produces an error, including when there is no README file.

Overview

Static methods

check

Return whether the README has an installation heading.

Import detail

from src.ansys.pre_commit_hooks.quality_rules.readme import RM005

Method detail

static RM005.check(repository_root: pathlib.Path, readme_file: str | None) → ansys.pre_commit_hooks.quality_rules.common.RuleCheckResult

Return whether the README has an installation heading.

Parameters:

repository_rootpathlib.Path

Repository root directory.

readme_filestr or None

Name of the detected README file, or None if there is none.

Returns:

bool or str

True if the heading exists, False otherwise, or an "ERROR: ..." message if the README cannot be read.