Skip to content

diffguard-types/lib.rs:520: SensorReport::code doc says rule_id without backticks (doc_markdown lint) #573

@EffortlessSteven

Description

@EffortlessSteven

clippy::doc_markdown lint flags this in diffguard-types/lib.rs:520:

/// Rule code (maps from rule_id, e.g., "rust.no_unwrap").

"rule_id" appears unescaped. The identifier should be wrapped in backticks per Rust doc conventions.

This is the same class of bug as issue #555 (which fixed conform_real.rs:698,805). The prior fix didn't catch this occurrence in SensorReport::code's doc comment.

Fix: Change to:

/// Rule code (maps from `rule_id`, e.g., \`"rust.no_unwrap"\`).

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions