fix docstrings

astronomy-commons · Nov 14, 2023 · 61b8890 · 61b8890
1 parent 5abe1a7
commit 61b8890
Showing 1 changed file with 4 additions and 4 deletions.
diff --git a/src/lsdb/io/to_hipscat.py b/src/lsdb/io/to_hipscat.py
@@ -24,16 +24,16 @@ def perform_write(
         base_catalog_dir: FilePointer,
         storage_options: dict | None = None,
         **kwargs
-):
+) -> int:
     """Performs a write of a pandas dataframe to a single parquet file, following the hipscat structure.
 
     To be used as a dask delayed method as part of a dask task graph.
 
     Args:
         df (pd.DataFrame): dataframe to write to file
-        hp_pixel: HEALPix pixel of file to be written
-        base_catalog_dir: Location of the base catalog directory to write to
-        storage_options: fsspec storage options
+        hp_pixel (HealpixPixel): HEALPix pixel of file to be written
+        base_catalog_dir (FilePointer): Location of the base catalog directory to write to
+        storage_options (dict): fsspec storage options
         **kwargs: other kwargs to pass to pd.to_parquet method
 
     Returns: