Skip to content

Commit

Permalink
Add more information to docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
jlorieau committed Jul 29, 2023
1 parent fca1615 commit a518c89
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions geomancy/checks/version.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,8 @@ def value(self, v):

@abstractmethod
def get_current_version(self) -> t.Union[None, t.Tuple[int]]:
"""Get the current version, or None if it can't be found."""
"""Get the current version as a tuple of integers, or None if it can't
be found."""
return None

def check(self, level: int = 0) -> CheckResult:
Expand All @@ -58,7 +59,7 @@ def check(self, level: int = 0) -> CheckResult:
and op is not None
and not op(current_version, version)
):
status = f"version={'.'.join(map(str, current_version))}"
status = f"incorrect version=" f"{'.'.join(map(str, current_version))}"
else:
status = "passed"
passed = True
Expand Down

0 comments on commit a518c89

Please sign in to comment.