Skip to content

RuleMetadata

Source code in docs_src/capo_codeguru_reviewer/types/rule_metadata.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
class RuleMetadata(TypedDict, closed=True):
    rule_id: NotRequired["capo_codeguru_reviewer.types.rule_id.RuleId"]
    """<p>The ID of the rule.</p>"""
    rule_name: NotRequired["capo_codeguru_reviewer.types.rule_name.RuleName"]
    """<p>The name of the rule.</p>"""
    short_description: NotRequired[
        "capo_codeguru_reviewer.types.short_description.ShortDescription"
    ]
    """<p>A short description of the rule.</p>"""
    long_description: NotRequired[
        "capo_codeguru_reviewer.types.long_description.LongDescription"
    ]
    """<p>A long description of the rule.</p>"""
    rule_tags: NotRequired["capo_codeguru_reviewer.types.rule_tags.RuleTags"]
    """<p>Tags that are associated with the rule.</p>"""

long_description instance-attribute 

long_description: NotRequired[LongDescription]

A long description of the rule.

rule_id instance-attribute 

rule_id: NotRequired[RuleId]

The ID of the rule.

rule_name instance-attribute 

rule_name: NotRequired[RuleName]

The name of the rule.

rule_tags instance-attribute 

rule_tags: NotRequired[RuleTags]

Tags that are associated with the rule.

short_description instance-attribute 

short_description: NotRequired[ShortDescription]

A short description of the rule.