make it harder to forget documentation in git-worktree

Author: Byron

git-worktree/src/fs/cache/mod.rs

@@ -1,3 +1,4 @@
+#![allow(missing_docs)]
 use std::path::{Path, PathBuf};
 
 use bstr::{BStr, ByteSlice};

git-worktree/src/fs/cache/state.rs

@@ -186,6 +186,9 @@ impl Ignore {
 }
 
 impl Attributes {
+    /// Create a new instance from an attribute match group that represents `globals`.
+    ///
+    /// A stack of attributes will be applied on top of it later.
     pub fn new(globals: AttributeMatchGroup) -> Self {
         Attributes {
             globals,

git-worktree/src/fs/mod.rs

@@ -23,6 +23,7 @@ pub struct Capabilities {
     pub symlink: bool,
 }
 
+/// A stack of path components with the delegation of side-effects as the currently set path changes, component by component.
 #[derive(Clone)]
 pub struct Stack {
     /// The prefix/root for all paths we handle.

git-worktree/src/fs/stack.rs

@@ -3,22 +3,38 @@ use std::path::{Path, PathBuf};
 use crate::fs::Stack;
 
 impl Stack {
+    /// Returns the top-level path of the stack.
     pub fn root(&self) -> &Path {
         &self.root
     }
 
+    /// Returns the absolute path the currently set path.
     pub fn current(&self) -> &Path {
         &self.current
     }
 
+    /// Returns the currently set path relative to the [`root()`][Stack::root()].
     pub fn current_relative(&self) -> &Path {
         &self.current_relative
     }
 }
 
+/// A delegate for use in a [`Stack`].
 pub trait Delegate {
+    /// Called whenever we push a directory on top of the stack, after the fact.
+    ///
+    /// It is also called if the currently acted on path is a directory in itself.
+    /// Use `stack.current()` to see the directory.
     fn push_directory(&mut self, stack: &Stack) -> std::io::Result<()>;
+
+    /// Called after any component was pushed, with the path available at `stack.current()`.
+    ///
+    /// `is_last_component` is true if the path is completely built.
     fn push(&mut self, is_last_component: bool, stack: &Stack) -> std::io::Result<()>;
+
+    /// Called right after a directory-component was popped off the stack.
+    ///
+    /// Use it to pop information off internal data structures.
     fn pop_directory(&mut self);
 }
 

git-worktree/src/index/checkout.rs

@@ -1,3 +1,4 @@
+#![allow(missing_docs)]
 use bstr::BString;
 use git_attributes::Attributes;
 

git-worktree/src/lib.rs

@@ -4,11 +4,12 @@
     cfg_attr(doc, doc = ::document_features::document_features!())
 )]
 #![deny(unsafe_code)]
-#![deny(rust_2018_idioms)]
+#![deny(rust_2018_idioms, missing_docs)]
 
 /// file system related utilities
 pub mod fs;
 
+///
 pub mod index;
 
 pub(crate) mod os;