From be7ba88e7d746936b7bc3ccd0ea83f46937610fe Mon Sep 17 00:00:00 2001 From: Teddy Wing Date: Thu, 17 Sep 2020 03:04:45 +0200 Subject: lib.rs: Add doc comments --- src/lib.rs | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/lib.rs b/src/lib.rs index 1505711..c408750 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -18,6 +18,13 @@ pub struct Todos<'a> { } impl Todos<'_> { + /// Write TODO lines. + /// + /// Writes TODO lines since `tree` to `write_to`. + /// + /// # Panics + /// + /// Panics if writing to `write_to` fails. pub fn write_since( &self, tree: Tree<'_>, @@ -57,6 +64,7 @@ impl Todos<'_> { Ok(()) } + /// Get a Git tree for the master branch. pub fn master_tree(&self) -> Result, Error> { let master = self.repo.find_branch("master", git2::BranchType::Local)?; -- cgit v1.2.3