Small updates to readability.

Author: dtaivpp

.pre-commit-hooks.yaml

@@ -1,6 +1,6 @@
 
 -   id: commit-msg-regex-hook
-    name: commit-msg-regex-hook
+    name: Validate commit message with Regex
     description: Checks if commit message matches the passed in regex
     entry: commit-msg-regex-hook
     language: python

README.md

@@ -13,7 +13,7 @@ First you will need to setup [pre-commit](https://pre-commit.com/) using their d
   rev: v0.3.1
   hooks:
     - id: commit-msg-hook
-      args: [--pattern='[A-Z]{3,4}-[0-9]{3,6} \\| [\\w\\s]* \\| .+']
+      args: ["--pattern='[A-Z]{3,4}-[0-9]{3,6} \\| [\\w\\s]* \\| .+'"]
       stages: [commit-msg]
 ```
 

commit_msg_regex_hook/commit_msg_regex_hook.py

@@ -62,7 +62,6 @@ def main():
 
 def process_file(path: str) -> str:
   """Extract commit message.  
-  On failure the commit is aborted. 
 
   Args:
       path (str): The path of the file with commit message
@@ -78,15 +77,19 @@ def process_file(path: str) -> str:
   return msg
 
 
-def process_pattern(pattern_str: str) -> Pattern:
-  """Verify regex pattern and return the pattern object
+def process_pattern(str_pattern: str) -> Pattern:
+  """Convert string pattern to regex pattern object.
+
+  Args:
+      pattern_str (str): The path of the file with commit message
+  Returns:
+      pattern (Pattern): The compiled regex pattern.
   """
   try:
-    print(f"Incoming Pattern: {pattern_str}")
-    pattern = re.compile(pattern_str[1:-1])
+    pattern = re.compile(str_pattern[1:-1])
   except Exception as e:
     raise argparse.ArgumentTypeError(
-      f"'{pattern_str}' is not a valid regex pattern\n {e}"
+      f"'{str_pattern}' is not a valid regex pattern\n {e}"
     )
 
   return pattern