From db3cd90f19ec8900a3d50fb4cb6096b3248123e4 Mon Sep 17 00:00:00 2001
From: William Emfinger <waemfinger@gmail.com>
Date: Tue, 16 Dec 2025 22:07:58 -0600
Subject: [PATCH] doc(interrupt): Update interrupt filter configuration to
 indicate that enabling pin filtering prevents light sleep

---
 components/interrupt/include/interrupt.hpp | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/components/interrupt/include/interrupt.hpp b/components/interrupt/include/interrupt.hpp
index 1295fbea9..46337d465 100644
--- a/components/interrupt/include/interrupt.hpp
+++ b/components/interrupt/include/interrupt.hpp
@@ -134,6 +134,9 @@ class Interrupt : public BaseComponent {
     FilterType filter_type =
         FilterType::NONE;         ///< The type of filter to use. If set to FLEX_GLITCH_FILTER, the
                                   ///< filter_config should be set.
+                                  ///<
+                                  ///< @note If not FilterType::NONE, then light
+                                  ///        sleep will be disabled.
     FilterConfig filter_config{}; ///< The configuration for the filter. This is only used if
                                   ///< filter_type is set to FLEX_GLITCH_FILTER
   };