diff options
Diffstat (limited to 'src/aggregate.rs')
| -rw-r--r-- | src/aggregate.rs | 3 |
1 files changed, 3 insertions, 0 deletions
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, |