From 67df504671c71d367e929efee3147156871bc027 Mon Sep 17 00:00:00 2001
From: Alex Okafor <45021773+AlexOkafor@users.noreply.github.com>
Date: Mon, 20 Nov 2023 20:17:11 -0500
Subject: [PATCH] Add doc_markdown clippy linting config to cargo workspace
 (#10640)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

# 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>
---
 Cargo.toml           | 1 +
 tools/ci/src/main.rs | 3 +--
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/Cargo.toml b/Cargo.toml
index 6e1bafd1dd..78725d2084 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -31,6 +31,7 @@ members = [
 
 [workspace.lints.clippy]
 type_complexity = "allow"
+doc_markdown = "warn"
 
 [lints]
 workspace = true
diff --git a/tools/ci/src/main.rs b/tools/ci/src/main.rs
index ebb12c2786..239cefd3f6 100644
--- a/tools/ci/src/main.rs
+++ b/tools/ci/src/main.rs
@@ -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",