Skip to content

Commit

Permalink
docs: document get_conventional_message
Browse files Browse the repository at this point in the history
  • Loading branch information
its-danny authored and oknozor committed Nov 30, 2021
1 parent aa002ba commit 72b2722
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -326,6 +326,8 @@ impl CocoGitto {
Ok(logs)
}

/// Tries to get a commit message conforming to the Conventional Commit spec.
/// If the commit message does _not_ conform, `None` is returned instead.
pub fn get_conventional_message(
commit_type: &str,
scope: Option<String>,
Expand Down

0 comments on commit 72b2722

Please sign in to comment.