Skip to content

Commit

Permalink
Add doc_markdown clippy linting config to cargo workspace (#10640)
Browse files Browse the repository at this point in the history
# Objective

Partially Addresses #10612

fix: add clippy::doc_markdown linting to cargo workspace

Rather than do all the warnings in `tools/ci/src/main.rs` in one-shot,
just wanted to have an initial pr adding the first one to get the form
correct as some may trigger build errors and require changes to get
merged more easily.

## Solution

- adding the doc_markdown and removing it from the ci check as it'll now
be a build error during normal compilation.

---------

Co-authored-by: François <mockersf@gmail.com>
  • Loading branch information
AlexOkafor and mockersf authored Nov 21, 2023
1 parent 5a4a288 commit 67df504
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
1 change: 1 addition & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ members = [

[workspace.lints.clippy]
type_complexity = "allow"
doc_markdown = "warn"

[lints]
workspace = true
Expand Down
3 changes: 1 addition & 2 deletions tools/ci/src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,7 @@ bitflags! {
}
}

const CLIPPY_FLAGS: [&str; 6] = [
"-Wclippy::doc_markdown",
const CLIPPY_FLAGS: [&str; 5] = [
"-Wclippy::redundant_else",
"-Wclippy::match_same_arms",
"-Wclippy::semicolon_if_nothing_returned",
Expand Down

0 comments on commit 67df504

Please sign in to comment.