From 109aab2570ea8375a729f09378479f69040e72b6 Mon Sep 17 00:00:00 2001 From: Melissa DeLucchi Date: Tue, 17 Sep 2024 10:16:36 -0400 Subject: [PATCH] Correct docstrings. --- src/hipscat_cloudtests/file_checks.py | 4 ++-- src/hipscat_cloudtests/temp_cloud_directory.py | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/hipscat_cloudtests/file_checks.py b/src/hipscat_cloudtests/file_checks.py index 7110ad2..2cd9dc6 100644 --- a/src/hipscat_cloudtests/file_checks.py +++ b/src/hipscat_cloudtests/file_checks.py @@ -23,7 +23,7 @@ def assert_text_file_matches(expected_lines, file_name): Args: expected_lines(:obj:`string array`) list of strings, formatted as regular expressions. - file_name (str): fully-specified path of the file to read + file_name (UPath): fully-specified path of the file to read """ assert does_file_or_directory_exist(file_name), f"file not found [{file_name}]" contents = load_text_file(file_name) @@ -43,7 +43,7 @@ def assert_parquet_file_ids(file_name, id_column, schema: pa.Schema, expected_id a list of expected objects. Args: - file_name (str): fully-specified path of the file to read + file_name (UPath): fully-specified path of the file to read id_column (str): column in the parquet file to read IDs from expected_ids (:obj:`int[]`): list of expected ids in `id_column` resort_ids (bool): should we re-sort the ids? if False, we will check that the ordering diff --git a/src/hipscat_cloudtests/temp_cloud_directory.py b/src/hipscat_cloudtests/temp_cloud_directory.py index 2ebc9f0..1782883 100644 --- a/src/hipscat_cloudtests/temp_cloud_directory.py +++ b/src/hipscat_cloudtests/temp_cloud_directory.py @@ -30,7 +30,7 @@ def __enter__(self): """Create a new temporary path Returns: - string path that's been created. it will take the form of + UPath object that's been created. it will take the form of / """ return self.open() @@ -39,7 +39,7 @@ def open(self): """Create a new temporary path Returns: - string path that's been created. it will take the form of + UPath object that's been created. it will take the form of / """ my_uuid = shortuuid.uuid()