Skip to content

Commit

Permalink
lib: improve docs and lints (#15)
Browse files Browse the repository at this point in the history
This adds some sanity lints and fixes a few typos in docs.
  • Loading branch information
Luca Bruno authored and XAMPPRocky committed Jan 17, 2020
1 parent e2747c6 commit dd12f96
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
3 changes: 2 additions & 1 deletion src/fs.rs
Expand Up @@ -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;
///
Expand Down
8 changes: 8 additions & 0 deletions 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;

Expand Down

0 comments on commit dd12f96

Please sign in to comment.