summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorClement Tsang <34804052+ClementTsang@users.noreply.github.com>2024-01-01 10:34:53 +0000
committerGitHub <noreply@github.com>2024-01-01 05:34:53 -0500
commite71048e394626d8a2ae148e8bc92a11aeda1f116 (patch)
treeb557286b7031b156a0c644fb6e8c62de98a7f3da
parentecb6faa089271be48325eb7371a3a01a17683ba4 (diff)
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.
-rw-r--r--Cargo.toml15
-rw-r--r--src/app/filter.rs10
-rw-r--r--src/lib.rs4
3 files changed, 27 insertions, 2 deletions
diff --git a/Cargo.toml b/Cargo.toml
index b49bcc67..883a9fb3 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -208,3 +208,18 @@ assets = [
{ source = "completion/_btm", dest = "/usr/share/zsh/vendor-completions/", mode = "644" },
{ source = "desktop/bottom.desktop", dest = "/usr/share/applications/bottom.desktop", mode = "644" },
]
+
+# Activate whenever we bump the unofficial MSRV to 1.74, I guess?
+# [lints.rust]
+# rust_2018_idioms = "deny"
+# missing_docs = "deny"
+# unused_extern_crates = "deny"
+
+# [lints.rustdoc]
+# broken_intra_doc_links = "deny"
+# missing_crate_level_docs = "deny"
+
+# [lints.clippy]
+# todo = "deny"
+# unimplemented = "deny"
+# missing_safety_doc = "deny"
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>,
}
diff --git a/src/lib.rs b/src/lib.rs
index 51ed85de..d84e25e7 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -6,6 +6,10 @@
//! bottom, refer to [here](https://clementtsang.github.io/bottom/stable/).
#![deny(rust_2018_idioms)]
+// #![deny(missing_docs)]
+#![deny(unused_extern_crates)]
+#![deny(rustdoc::broken_intra_doc_links)]
+#![deny(rustdoc::missing_crate_level_docs)]
#![deny(clippy::todo)]
#![deny(clippy::unimplemented)]
#![deny(clippy::missing_safety_doc)]