Skip to content

Commit

Permalink
Correct docstrings.
Browse files Browse the repository at this point in the history
  • Loading branch information
delucchi-cmu committed Sep 17, 2024
1 parent 7e4977c commit 109aab2
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions src/hipscat_cloudtests/file_checks.py
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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
Expand Down
4 changes: 2 additions & 2 deletions src/hipscat_cloudtests/temp_cloud_directory.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
<prefix_path>/<method_name><some random string>
"""
return self.open()
Expand All @@ -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
<prefix_path>/<method_name><some random string>
"""
my_uuid = shortuuid.uuid()
Expand Down

0 comments on commit 109aab2

Please sign in to comment.