Back to Foundry

Template

crates/lint/docs/_template.md

1.8.1588 B
Original Source

<Lint name>

Severity: <High | Med | Low | Info | Gas | CodeSize> ID: <str_id>

One-paragraph summary of what this lint detects and why it matters.

What it does

Explain precisely what the lint flags.

Why is this bad?

Explain the impact (security, correctness, gas, readability).

Example

Bad

solidity
// triggering example

Good

solidity
// non-triggering, recommended example

Configuration

Document any inline-config or foundry.toml options that affect this lint. Omit this section when the lint has no additional configuration.