From 21d54b5901a9e87f1f71db656b0555386a7d934a Mon Sep 17 00:00:00 2001
From: "Steven Zimmerman, CPA"
 <15812269+EffortlessSteven@users.noreply.github.com>
Date: Fri, 17 Apr 2026 02:56:33 +0000
Subject: [PATCH] docs(types): add missing # Panics section to
 ConfigFile::built_in()

Satisfies clippy::missing_panics_doc by documenting that the function
panics if built_in.json cannot be parsed as valid JSON.
---
 crates/diffguard-types/src/lib.rs | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/crates/diffguard-types/src/lib.rs b/crates/diffguard-types/src/lib.rs
index b634c06b..38bdc860 100644
--- a/crates/diffguard-types/src/lib.rs
+++ b/crates/diffguard-types/src/lib.rs
@@ -245,6 +245,10 @@ impl ConfigFile {
     ///
     /// Rules are loaded from `rules/built_in.json` at compile time via `include_str!`.
     /// This ensures the JSON is embedded in the binary and avoids any I/O at runtime.
+    ///
+    /// # Panics
+    ///
+    /// Panics if `built_in.json` cannot be parsed as valid JSON.
     #[must_use]
     pub fn built_in() -> Self {
         serde_json::from_str(include_str!("rules/built_in.json"))