Skip to content

Commit

Permalink
fix documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
kwk committed Apr 25, 2024
1 parent 344728e commit 3aa970b
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions snapshot_manager/snapshot_manager/util.py
Original file line number Diff line number Diff line change
Expand Up @@ -171,17 +171,17 @@ def golden_file_path(basename: str, extension: str = ".golden.txt") -> pathlib.P

def get_yyyymmdd_from_string(string: str) -> str:
"""Returns the year-month-day combination in YYYYMMDD form from
an issue `title` or raises an error.
`string` or raises an error.
Args:
title (str): The title of a github issue
string (str): e.g. the title of a github issue
Raises:
ValueError: If `title` doesn't contain proper YYYYMMDD string
ValueError: If `string` doesn't contain proper YYYYMMDD string
ValueError: If the date in the title is invalid
Returns:
str: The year-month-day extracted from `title`
str: The year-month-day extracted from `string`
Examples:
Expand Down

0 comments on commit 3aa970b

Please sign in to comment.