docs(format): improve doc strings for verbose commit messages

compilerla · Jul 23, 2024 · 800b147 · 800b147
1 parent 28dbfe5
commit 800b147
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/conventional_pre_commit/format.py b/conventional_pre_commit/format.py
@@ -68,11 +68,12 @@ def r_autosquash_prefixes():
 
 
 def r_verbose_commit_ignored():
-    """Regex str for verbose diff"""
+    """Regex str for the ignored part of verbose commit message templates"""
     return r"^# -{24} >8 -{24}\r?\n.*\Z"
 
 
 def strip_verbose_commit_ignored(input):
+    """Strip the ignored part of verbose commit message templates."""
     return re.sub(r_verbose_commit_ignored(), "", input, flags=re.DOTALL | re.MULTILINE)