check_naming_convention

Summary

check_naming_convention(bundle: Bundle, skip: bool = False, skip_warnings: bool = False)

Checks to see if files are named appropriately.

Parameters:

  • bundle (cs_board_tools.schema.bundle.Bundle) – The Board Bundle.

  • skip (bool) – If set to True, the check will be skipped, but a valid result object with no messages and SKIPPED as its status will still be returned.

  • skip_warnings (bool, optional) – If set, skips tests resulting in “Warning” messages.

Returns:

A CheckResult object containing the check status as well as any messages and additional data.

Return type:

CheckResult

Importing

from cs_board_tools.validation.naming import check_naming_convention