From 310cd6af912cda7333496d5d5d80a68d6ea9b155 Mon Sep 17 00:00:00 2001
From: Sebastian Thiel <sthiel@thoughtworks.com>
Date: Sat, 1 Jun 2019 15:42:17 +0530
Subject: Add minimal library documentation

---
 src/aggregate.rs | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'src/aggregate.rs')

diff --git a/src/aggregate.rs b/src/aggregate.rs
index 6079e04..5fe5536 100644
--- a/src/aggregate.rs
+++ b/src/aggregate.rs
@@ -3,6 +3,9 @@ use failure::Error;
 use std::borrow::Cow;
 use std::{io, path::Path};
 
+/// Aggregate the given `paths` and write information about them to `out` in a human-readable format.
+/// If `compute_total` is set, it will write an additional line with the total size across all given `paths`.
+/// If `sort_by_size_in_bytes` is set, we will sort all sizes (ascending) before outputting them.
 pub fn aggregate(
     mut out: impl io::Write,
     options: WalkOptions,
-- 
cgit v1.2.3