fix: add missing docstrings

Signed-off-by: Terri Oda <[email protected]>
terriko · Jan 5, 2024 · fb2cbb9 · fb2cbb9
1 parent 763fa1f
commit fb2cbb9
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/cve_bin_tool/version_compare.py b/cve_bin_tool/version_compare.py
@@ -190,6 +190,7 @@ def __repr__(self):
         return f"Version: {self} aka {parse_version(self)}"
 
     def is_hash(self):
+        """Check to see if a version looks like it contains a hash"""
         if re.match("[a-fA-F0-9]{8,}", self) is None:
             return False
         return True
diff --git a/test/test_version_compare.py b/test/test_version_compare.py
@@ -66,5 +66,6 @@ def test_error(self):
             Version("") > Version("6")
 
     def test_ne(self):
+        """Test some != cases with hashes to make sure we aren't comparing the string 'HASH'"""
         assert Version("f835f2caab") != Version("f835f2caaa")
         assert Version("HASH") != Version("f835f2caaa")