From 17310ee4b5557ae4d22232ae4ab6c79d0efe4d36 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fe=CC=81lix=20Saparelli?= Date: Sat, 16 Oct 2021 17:13:32 +1300 Subject: [PATCH] Docs: modules --- lib/src/filter.rs | 2 ++ lib/src/filter/tagged.rs | 2 ++ lib/src/filter/tagged/swaplock.rs | 2 ++ lib/src/lib.rs | 2 +- 4 files changed, 7 insertions(+), 1 deletion(-) diff --git a/lib/src/filter.rs b/lib/src/filter.rs index 59a74ae..ea808f6 100644 --- a/lib/src/filter.rs +++ b/lib/src/filter.rs @@ -1,3 +1,5 @@ +//! The `Filterer` trait, two implementations, and some helper functions. + use std::sync::Arc; use ignore::gitignore::GitignoreBuilder; diff --git a/lib/src/filter/tagged.rs b/lib/src/filter/tagged.rs index 3b8a924..4d09c44 100644 --- a/lib/src/filter/tagged.rs +++ b/lib/src/filter/tagged.rs @@ -1,3 +1,5 @@ +//! A complex filterer that can match any event tag and supports different matching operators. + use std::collections::{HashMap, HashSet}; use std::path::PathBuf; use std::sync::Arc; diff --git a/lib/src/filter/tagged/swaplock.rs b/lib/src/filter/tagged/swaplock.rs index 5f4e056..8271449 100644 --- a/lib/src/filter/tagged/swaplock.rs +++ b/lib/src/filter/tagged/swaplock.rs @@ -1,3 +1,5 @@ +//! A value that is always available, but can be swapped out. + use std::fmt; use tokio::sync::watch::{channel, error::SendError, Receiver, Ref, Sender}; diff --git a/lib/src/lib.rs b/lib/src/lib.rs index 9a1f170..2a39a62 100644 --- a/lib/src/lib.rs +++ b/lib/src/lib.rs @@ -82,7 +82,7 @@ #![doc(html_favicon_url = "https://watchexec.github.io/logo:watchexec.svg")] #![doc(html_logo_url = "https://watchexec.github.io/logo:watchexec.svg")] -#![warn(clippy::unwrap_used)] +#![warn(clippy::unwrap_used, missing_docs)] #![forbid(unsafe_code)] // the toolkit to make your own