add doc

JannisNe · Mar 24, 2023 · de08ab1 · de08ab1
1 parent e57996a
commit de08ab1
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/timewise/wise_data_base.py b/timewise/wise_data_base.py
@@ -1501,6 +1501,16 @@ def calculate_position_mask(lightcurve):
         return pd.Series(keep_mask).to_dict()
 
     def get_position_mask(self, service, chunk_number):
+        """
+        Get the position mask for a chunk
+
+        :param service: The service that was used to download the data, either of `gator` or `tap`
+        :type service: str
+        :param chunk_number: chunk number
+        :type chunk_number: int
+        :returns: position masks
+        :rtype: dict
+        """
 
         logger.info(f"getting position masks for {service}, chunk {chunk_number}")
         fn = os.path.join(self.cache_dir, "position_masks", f"{service}_chunk{chunk_number}.json")