Human-readable description for a rule_id, for SARIF’s shortDescription.

Returns:

The description from _RULE_DESCRIPTIONS, or – for a rule_id not

Methods

_rule_short_description

_rule_short_description(rule_id: str) -> str

Human-readable description for a rule_id, for SARIF’s shortDescription.

Returns:

The description from _RULE_DESCRIPTIONS, or – for a rule_id not

ParameterTypeDescription
rule_idstrThe rule identifier (e.g. “undocumented-entity”).

Generated with Flude

Copyright © 2026