From 71396635441ccdb0c63065feca0784bb346e2a71 Mon Sep 17 00:00:00 2001
From: Max Smirnov <masynchin@gmail.com>
Date: Mon, 22 Aug 2022 10:51:57 +0300
Subject: [PATCH] Add docs to count_repositories

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

diff --git a/src/count.rs b/src/count.rs
index d663ed8..b02ba1a 100644
--- a/src/count.rs
+++ b/src/count.rs
@@ -1,6 +1,9 @@
 use crate::error::Result;
 use std::{fs::{read_dir, ReadDir}, path::Path, result::Result as StdResult, iter::once};
 
+/// The on disk layout for served repos is `<service>/<user>/<repo>`
+/// so to get the amount of repos, we just have to count everything
+/// in `*/*/*` to get the count.
 #[instrument]
 pub(crate) fn count_repositories<P>(repo_path: P) -> Result<usize>
 where