manifest_checker.check_readme_exists() – stagecoach | stagecoach

manifest_checker.check_readme_exists()

Check whether the project contains a top-level README document.

Usage

manifest_checker.check_readme_exists(directory)

Parameters

directory: Path: Project directory to inspect.

Returns

CheckResult: Passes when a supported README filename exists and errors otherwise.