From e71048e394626d8a2ae148e8bc92a11aeda1f116 Mon Sep 17 00:00:00 2001
From: Clement Tsang <34804052+ClementTsang@users.noreply.github.com>
Date: Mon, 1 Jan 2024 10:34:53 +0000
Subject: other: update lints (#1369)

I have `missing_docs` disabled for now as that'll take a long time to
get through... maybe in a separate PR.
---
 src/app/filter.rs | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

(limited to 'src/app')

diff --git a/src/app/filter.rs b/src/app/filter.rs
index 22c08e29..574fdab4 100644
--- a/src/app/filter.rs
+++ b/src/app/filter.rs
@@ -1,7 +1,13 @@
+/// Filters used by widgets to filter out certain entries.
+/// TODO: Move this out maybe?
 #[derive(Debug, Clone)]
 pub struct Filter {
-    // TODO: Maybe change to "ignore_matches"?
-    pub is_list_ignored: bool,
+    /// Whether the filter _accepts_ all entries that match `list`,
+    /// or _denies_ any entries that match it.
+    pub is_list_ignored: bool, // TODO: Maybe change to "ignore_matches"?
+
+    /// The list of regexes to match against. Whether it goes through
+    /// the filter or not depends on `is_list_ignored`.
     pub list: Vec<regex::Regex>,
 }
 
-- 
cgit v1.2.3