Docstring and test fix

Author: traut

detection_rules/rule.py

@@ -1132,6 +1132,8 @@ def to_api_format(self, include_version: bool = True) -> dict:
 
 
     def get_hashable_content(self, include_version: bool = False, include_integrations: bool = False) -> dict:
+        """Returns the rule content to be used for calculating the hash value for the rule"""
+
         # get the API dict without the version by default, otherwise it'll always be dirty.
         hashable_dict = self.to_api_format(include_version=include_version)
 
@@ -1143,6 +1145,7 @@ def get_hashable_content(self, include_version: bool = False, include_integratio
 
     @cached
     def get_hash(self, include_version : bool = False, include_integrations: bool = False) -> str:
+        """Returns a sha256 hash of the rule contents"""
         hashable_contents = self.get_hashable_content(
             include_version=include_version,
             include_integrations=include_integrations,

tests/test_packages.py

@@ -43,7 +43,7 @@ def get_rule_contents():
         version_info = {
             rule.id: {
                 'rule_name': rule.name,
-                'sha256': rule.contents.sha256(),
+                'sha256': rule.contents.get_hash(),
                 'version': version
             } for rule in rules
         }
@@ -76,7 +76,7 @@ def test_rule_versioning(self):
         # test that no rules have versions defined
         for rule in rules:
             self.assertGreaterEqual(rule.contents.autobumped_version, 1, '{} - {}: version is not being set in package')
-            original_hashes.append(rule.contents.sha256())
+            original_hashes.append(rule.contents.get_hash())
 
         package = Package(rules, 'test-package')
 
@@ -87,7 +87,7 @@ def test_rule_versioning(self):
 
         # test that rules validate with version
         for rule in package.rules:
-            post_bump_hashes.append(rule.contents.sha256())
+            post_bump_hashes.append(rule.contents.get_hash())
 
         # test that no hashes changed as a result of the version bumps
         self.assertListEqual(original_hashes, post_bump_hashes, 'Version bumping modified the hash of a rule')