Skip to content

Commit

Permalink
Updated docstring for is_prime
Browse files Browse the repository at this point in the history
  • Loading branch information
NikosDelijohn committed Oct 11, 2024
1 parent 5ac2f62 commit f8999a3
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion src/testcrush/zoix.py
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,13 @@ def cast_attribute(self, attribute: str, func: callable) -> None:
log.critical(f"Unable to cast to {repr(func)} of attribute {getattr(self, attribute)}")
exit(1)

def is_prime(self):
def is_prime(self) -> bool:
"""
Checks whether the fault is a prime fault, i.e., is not equivalent to any other fault.
Returns:
bool: True if fault is prime. False otherwise.
"""
return self.equivalent_to is None


Expand Down

0 comments on commit f8999a3

Please sign in to comment.