Skip to content

Commit 800b147

Browse files
committed
docs(format): improve doc strings for verbose commit messages
1 parent 28dbfe5 commit 800b147

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

conventional_pre_commit/format.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,11 +68,12 @@ def r_autosquash_prefixes():
6868

6969

7070
def r_verbose_commit_ignored():
71-
"""Regex str for verbose diff"""
71+
"""Regex str for the ignored part of verbose commit message templates"""
7272
return r"^# -{24} >8 -{24}\r?\n.*\Z"
7373

7474

7575
def strip_verbose_commit_ignored(input):
76+
"""Strip the ignored part of verbose commit message templates."""
7677
return re.sub(r_verbose_commit_ignored(), "", input, flags=re.DOTALL | re.MULTILINE)
7778

7879

0 commit comments

Comments
 (0)