docs

src/integrations/git/mod.rs

@@ -167,13 +167,15 @@ pub fn fast_forward_pull(repo: Repository, branch: &str) -> Result<Option<HeadIn
     }
 }
 
+/// Commit hash, author and timestamp for head commit
 pub struct HeadInfo
 {
     pub hash: git2::Oid,
     pub author: String,
     pub datetime: String 
 }
 
+/// Get the [HeadInfo] if it exists
 pub fn head_info(repo: &Repository) -> Option<HeadInfo>
 {
     let head = match repo.head()

src/integrations/git/refresh.rs

@@ -36,6 +36,8 @@ impl GitRefreshTask
         }
     }
 
+    /// Attempt a fast forward pull of the repo in [crate::config::ContentConfig::path]
+    ///   clone if it is not there. Does nothing if [crate::config::GitConfig] is none
     pub fn pull(config: &Config) -> Option<HeadInfo>
     {
 
@@ -72,6 +74,7 @@ impl GitRefreshTask
         None
     }
 
+    /// Send a discord message with [HeadInfo] if it is Some
     pub async fn notify_pull(info: Option<HeadInfo>, config: &Config)
     {
         match info

src/integrations/github/mod.rs

@@ -6,6 +6,9 @@ use crate::config::{Config, CONFIG_PATH};
 
 use super::git::refresh::GitRefreshTask;
 
+/// If user-agent is GitHub-Hookshot, check if
+///  x-github-event is push. If so pull the repo if
+///  [crate::config::GitConfig] is not None
 pub async fn filter_github<B>
 (
     headers: HeaderMap,