Add doc comments. Add doc test. (#22)

.github/workflows/nightly.yml

@@ -6,12 +6,6 @@ on:
       - "README.md"
       - "LICENSE-*"
       - ".gitignore"
-  pull_request:
-    branches: ["main"]
-    paths-ignore:
-      - "README.md"
-      - "LICENSE-*"
-      - ".gitignore"
 env:
   CARGO_TERM_COLOR: always
 

src/bytes.rs

@@ -1,5 +1,4 @@
 #![allow(clippy::cast_precision_loss)]
-
 use std::fmt::Display;
 
 pub fn humanize(bytes: u64) -> String {

src/lib.rs

@@ -1,3 +1,4 @@
+//! Find large files on your system.
 mod bytes;
 mod files;
 
@@ -10,6 +11,17 @@ use files::File;
 /// # Errors
 ///
 /// Returns an I/O error if unable to scan the provided path.
+///
+/// # Examples
+///
+/// ```
+/// # use spacehog::find_top_n_largest_files;
+/// # fn main() {
+/// let result = find_top_n_largest_files("testdata", 5).unwrap();
+///
+/// assert_eq!(result.len(), 4);
+/// # }
+/// ```
 pub fn find_top_n_largest_files(path: &str, n: usize) -> io::Result<Vec<File>> {
     let mut results = BTreeMap::new();
     for file in files::from_path(path)? {

src/main.rs

@@ -1,3 +1,14 @@
+//! A simple utility for finding large files on your system.
+//!
+//! Usage: spacehog [OPTIONS] [PATH]
+//!
+//! Arguments:
+//!   [PATH]  [default: .]
+//!
+//! Options:
+//!   -n <NUMBER>      [default: 5]
+//!   -h, --help       Print help
+//!   -V, --version    Print version
 use clap::Parser;
 use spinoff::{spinners, Color, Spinner};