From bd9fce47366e67ffaa8eb36f1d53f798b5442757 Mon Sep 17 00:00:00 2001
From: Luca BRUNO <luca.bruno@coreos.com>
Date: Fri, 17 Jan 2020 10:06:00 +0000
Subject: [PATCH] lib: improve docs and lints

This adds some sanity lints and fixes a few typos in docs.
---
 src/fs.rs  | 3 ++-
 src/lib.rs | 8 ++++++++
 2 files changed, 10 insertions(+), 1 deletion(-)

diff --git a/src/fs.rs b/src/fs.rs
index bca7b2b..d81bd65 100644
--- a/src/fs.rs
+++ b/src/fs.rs
@@ -20,7 +20,8 @@ struct RmdirContext<'a> {
     counter: u64,
 }
 
-/// Reliably removes directory and all of it's children.
+/// Reliably removes a directory and all of its children.
+///
 /// ```rust
 /// extern crate remove_dir_all;
 ///
diff --git a/src/lib.rs b/src/lib.rs
index 1f73c20..0dda5f6 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -1,3 +1,11 @@
+//! Reliably remove a directory and all of its children.
+//!
+//! This library provides a reliable implementation of `remove_dir_all` for Windows.
+//! For Unix systems, it re-exports `std::fs::remove_dir_all`.
+
+#![deny(missing_debug_implementations)]
+#![deny(missing_docs)]
+
 #[cfg(windows)]
 extern crate winapi;