From c90d237d2d39c1deac5f92344d13160bc16f50b7 Mon Sep 17 00:00:00 2001
From: Teddy Wing
Date: Sat, 29 May 2021 18:25:58 +0200
Subject: src/git.rs: Add function documentation

---
 src/git.rs | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

(limited to 'src')

diff --git a/src/git.rs b/src/git.rs
index 174f19f..017aae3 100644
--- a/src/git.rs
+++ b/src/git.rs
@@ -1,6 +1,13 @@
 use std::path::Path;
 
 
+/// Mirror a repository.
+///
+/// Works like:
+///
+/// ```shell
+/// git clone --mirror URL
+/// ```
 pub fn mirror<P: AsRef<Path>>(
     url: &str,
     path: P,
@@ -27,6 +34,13 @@ pub fn mirror<P: AsRef<Path>>(
     Ok(())
 }
 
+/// Update remotes.
+///
+/// Works like:
+///
+/// ```shell
+/// git remote update
+/// ```
 pub fn update<P: AsRef<Path>>(
     path: P,
 ) -> Result<(), Box<dyn std::error::Error>> {
-- 
cgit v1.2.3