Skip to content

Commit

Permalink
Match parquet path docstrings to behavior. (#235)
Browse files Browse the repository at this point in the history
  • Loading branch information
delucchi-cmu authored Mar 12, 2024
1 parent 2f9fced commit 2cf6d1c
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions src/hipscat/io/paths.py
Original file line number Diff line number Diff line change
Expand Up @@ -184,23 +184,23 @@ def get_provenance_pointer(catalog_base_dir: FilePointer) -> FilePointer:


def get_common_metadata_pointer(catalog_base_dir: FilePointer) -> FilePointer:
"""Get file pointer to `_metadata` parquet metadata file
"""Get file pointer to `_common_metadata` parquet metadata file
Args:
catalog_base_dir: pointer to base catalog directory
Returns:
File Pointer to the catalog's `_metadata` file
File Pointer to the catalog's `_common_metadata` file
"""
return append_paths_to_pointer(catalog_base_dir, PARQUET_COMMON_METADATA_FILENAME)


def get_parquet_metadata_pointer(catalog_base_dir: FilePointer) -> FilePointer:
"""Get file pointer to `_common_metadata` parquet metadata file
"""Get file pointer to `_metadata` parquet metadata file
Args:
catalog_base_dir: pointer to base catalog directory
Returns:
File Pointer to the catalog's `_common_metadata` file
File Pointer to the catalog's `_metadata` file
"""
return append_paths_to_pointer(catalog_base_dir, PARQUET_METADATA_FILENAME)

Expand Down

0 comments on commit 2cf6d1c

Please sign in to comment.