Skip to content

Commit

Permalink
added doc string
Browse files Browse the repository at this point in the history
Signed-off-by: Shashank Reddy Boyapally <[email protected]>
  • Loading branch information
shashank-boyapally committed Sep 9, 2024
1 parent 81423f6 commit 75270b0
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion fmatch/matcher.py
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,23 @@ def get_uuid_by_metadata(
lookback_date: datetime = None,
lookback_size: int = 10000,
) -> List[Dict[str, str]]:
"""get_uuid_by_metadata"""
"""gets uuid by metadata
Args:
meta (Dict[str, Any]): metadata of the runs
index (str, optional): Index to search. Defaults to None.
lookback_date (datetime, optional):
The cutoff date to get the uuids from. Defaults to None.
lookback_size (int, optional):
Maximum number of runs to get, gets the latest. Defaults to 10000.
lookback_size and lookback_date get the data on the
precedency of whichever cutoff comes first.
Similar to a car manufacturer's warranty limits.
Returns:
List[Dict[str, str]]: _description_
"""
if index is None:
index = self.index
version = meta["ocpVersion"][:4]
Expand Down

0 comments on commit 75270b0

Please sign in to comment.