Skip to content

Commit

Permalink
chore(clippy): ignore CometBFT as an identifier (#1913)
Browse files Browse the repository at this point in the history
## Summary
Allows writing CometBFT without backticks in Rust doc comments.

## Background
Clippy's pedantic settings consider CometBFT a Rust identifier because
of its CamelCase. That's annoying, because it's actually the name of the
consensus implementation we are using.

## Changes
- Create a `clippy.toml` in the root of the repository.
- Add `doc-allowed-idents = ["CometBFT"]` to it.

## Testing
Writing `CometBFT` in a Rust doc no longer triggers a clippy warning (no
lines in this PR).
  • Loading branch information
SuperFluffy authored Jan 14, 2025
1 parent 5c4feaf commit fd94ec0
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions clippy.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
doc-valid-idents = ["CometBFT", ".."]

0 comments on commit fd94ec0

Please sign in to comment.