repository(doc): top-level of 'path' module (#164)

git-repository/src/path/create.rs

@@ -1,3 +1,4 @@
+#![allow(missing_docs)]
 use std::{
     fs::{self, OpenOptions},
     io::Write,

git-repository/src/path/discover.rs

@@ -1,3 +1,4 @@
+#![allow(missing_docs)]
 use std::{
     borrow::Cow,
     path::{Component, Path},

git-repository/src/path/is_git.rs

@@ -1,3 +1,4 @@
+#![allow(missing_docs)]
 use std::path::{Path, PathBuf};
 
 #[derive(Debug, thiserror::Error)]

git-repository/src/path/mod.rs

@@ -1,5 +1,3 @@
-#![allow(missing_docs)]
-
 use std::path::PathBuf;
 
 pub use is_git::{is_bare, is_git};
@@ -20,20 +18,24 @@ impl AsRef<std::path::Path> for Path {
 }
 
 impl Path {
+    /// Instantiate a new path from `dir` which is expected to be the `.git` directory, with `kind` indicating
+    /// whether it's a bare repository or not.
     pub fn from_dot_git_dir(dir: impl Into<PathBuf>, kind: Kind) -> Self {
         let dir = dir.into();
         match kind {
             Kind::WorkTree => Path::WorkTree(dir.parent().expect("this is a sub-directory").to_owned()),
             Kind::Bare => Path::Repository(dir),
         }
     }
+    /// Returns the [kind][Kind] of this repository path.
     pub fn kind(&self) -> Kind {
         match self {
             Path::WorkTree(_) => Kind::WorkTree,
             Path::Repository(_) => Kind::Bare,
         }
     }
 
+    /// Consume and split this path into the location of the `.git` directory as well as an optional path to the work tree.
     pub fn into_repository_and_work_tree_directories(self) -> (PathBuf, Option<PathBuf>) {
         match self {
             crate::Path::WorkTree(working_tree) => (working_tree.join(".git"), Some(working_tree)),