massive documentaion and some refactoring.

1 files changed, 2 insertions, 0 deletions

diff --git a/src/git.rs b/src/git.rs
index ab6cf1f..af63936 100644
--- a/src/git.rs
+++ b/src/git.rs
@@ -75,6 +75,8 @@ fn parse_porcelain2(data: String) -> Option<GitStatus> {
     Some(status)
 }
 
+/// Returns a string representation of the git status of this path.
+/// Will return an empty string if we're not in a git repository.
 pub fn git(path: &Path) -> Result<String, Box<dyn Error>> {
     if std::env::set_current_dir(path).is_err() {
         // The path may not exist. It should never happen.