Document all the things, ensure it will forever be documented

Author: sondr3

src/author.rs

@@ -1,11 +1,16 @@
 use hashbrown::HashMap;
 use std::fmt;
 
+/// An author of a git commit.
 #[derive(Debug)]
 pub struct Author {
+    /// Name of the author.
     pub name: String,
+    /// Total count of commits by author.
     pub total_commits: usize,
+    /// Total count of curses used by author.
     pub total_curses: usize,
+    /// HashMap of all the curses the author used.
     pub curses: HashMap<String, usize>,
 }
 
@@ -20,6 +25,7 @@ impl fmt::Display for Author {
 }
 
 impl Author {
+    /// Initialize a new author from a name.
     pub fn new(name: impl Into<String>) -> Self {
         Author {
             name: name.into(),
@@ -29,6 +35,7 @@ impl Author {
         }
     }
 
+    /// Update a previously used curse or add a new one.
     pub fn update_occurrence(&mut self, curse: &str) {
         self.curses
             .get_mut(curse)
@@ -38,6 +45,7 @@ impl Author {
             })
     }
 
+    /// `git-anger-management` knows if you've been naughty or not
     pub fn is_naughty(&self) -> bool {
         !self.curses.is_empty()
     }

src/core.rs

@@ -5,12 +5,18 @@ lazy_static! {
     pub static ref CURSES: HashSet<&'static str> = CURSES_FILE.lines().collect();
 }
 
+/// Cleans a string and returns a list containing the cleaned up words.
+///
+/// Of note here is that the implementation splits on any character that is not
+/// a letter, even if it is in the middle of a "word". This should not be a
+/// problem.
 pub fn split_into_clean_words(input: &str) -> impl Iterator<Item = &str> {
     input
         .split(|c: char| !char::is_alphabetic(c))
         .filter(|w| !w.is_empty())
 }
 
+/// Checks if a word is naughty.
 pub fn naughty_word(word: &str) -> bool {
     CURSES.contains(&word)
 }

src/lib.rs

@@ -1,30 +1,29 @@
 #![cfg_attr(feature = "fail-on-warnings", deny(warnings))]
-//#![deny(missing_docs)]
-//#![deny(missing_debug_implementations)]
+#![deny(missing_docs)]
+#![deny(missing_debug_implementations)]
 #![forbid(unsafe_code)]
 #![doc(html_root_url = "https://docs.rs/git-anger-management/0.4.0")]
-
 //! # git-anger-management
 //!
 //! ## What
 //!
-//! Have you ever wondered how much you or your co-workers actually curse in your
-//! commit messages? Worry no more, `git-anger-management` is here to help you.
-//! Simply run it against your repository and it'll tell you who is the naughtiest
-//! of them all.
+//! Have you ever wondered how much you or your co-workers actually curse in
+//! your commit messages? Worry no more, `git-anger-management` is here to help
+//! you. Simply run it against your repository and it'll tell you who is the
+//! naughtiest of them all.
 //!
 //! ## Why
 //!
 //! Some times the only way to vent at the ridiculous crap we make is to write
-//! really angry commit messages, I do it all the time. And I wanted to know just
-//! how angry I get.
+//! really angry commit messages, I do it all the time. And I wanted to know
+//! just how angry I get.
 //!
 //! # Installation
 //!
 //! Make sure you have Rust installed (I recommend installing via
-//! [rustup](https://rustup.rs/)), then run `cargo install git-anger-management`.
-//! You can now check how naughty you are by running `git anger-management` in the
-//! directory where you want to check naughtiness.
+//! [rustup](https://rustup.rs/)), then run `cargo install
+//! git-anger-management`. You can now check how naughty you are by running `git
+//! anger-management` in the directory where you want to check naughtiness.
 //!
 //! Output should look something like this:
 //!

src/repo.rs

@@ -2,12 +2,18 @@ use author::Author;
 use hashbrown::HashMap;
 use std::fmt;
 
+/// A simple representation of a git repository.
 #[derive(Debug)]
 pub struct Repo {
+    /// Name of the repository.
     pub name: String,
+    /// Count of the total amount of commits in the repository.
     pub total_commits: usize,
+    /// Count of the total amount of curses used in the commits.
     pub total_curses: usize,
+    /// HashMap of all the naughty words used by the authors.
     pub curses: HashMap<String, usize>,
+    /// HashMap of all the authors that have been committed.
     pub authors: HashMap<String, Author>,
 }
 
@@ -22,6 +28,7 @@ impl fmt::Display for Repo {
 }
 
 impl Repo {
+    /// Creates a new and empty repository.
     pub fn new(name: impl Into<String>) -> Self {
         Repo {
             name: name.into(),
@@ -32,6 +39,8 @@ impl Repo {
         }
     }
 
+    /// Checks if an author exists and creates a new author if she/he doesn't
+    /// exist.
     pub fn author(&mut self, author_name: &str) -> &mut Author {
         if !self.authors.contains_key(author_name) {
             self.authors
@@ -42,6 +51,7 @@ impl Repo {
         self.authors.get_mut(author_name).expect("exists")
     }
 
+    /// Counts all the naughty words used by authors.
     pub fn count_curses(&mut self) {
         for author in self.authors.values() {
             for (curse, count) in &author.curses {

tests/version-numbers.rs

@@ -9,4 +9,4 @@ fn test_readme_deps() {
 #[test]
 fn test_html_root_url() {
     assert_html_root_url_updated!("src/lib.rs");
-}
+}