Documentation and typing

icecube · Oct 6, 2022 · ef82969 · ef82969
1 parent 973bcf8
commit ef82969
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 5 deletions.
diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -9,10 +9,11 @@
     .. automodule:: flarestack.core.data_types
         :members:
 
-###############
+#########################
 Data formats and datasets
-###############
+#########################
 .. automodule:: flarestack.data.dataset_index
+    :members:
 
 ###############
 Base PDFs

diff --git a/flarestack/data/dataset_index.py b/flarestack/data/dataset_index.py
@@ -12,9 +12,10 @@ class DatasetIndex:
     """Class storing an index for available datasets"""
 
     def __init__(self) -> None:
+        """constructor"""
         self.index = dict()
 
-    def add_dataset(self, name: str, object: Dataset):
+    def add_dataset(self, name: str, object: Dataset) -> None:
         """adds a dataset to the index
 
         Args:
@@ -23,7 +24,7 @@ def add_dataset(self, name: str, object: Dataset):
         """
         self.index[name] = object
 
-    def add_alias(self, alias: str, name: str):
+    def add_alias(self, alias: str, name: str) -> None:
         """adds an alias for a dataset
 
         Args:
@@ -53,12 +54,13 @@ def get_dataset(self, name: str) -> Dataset:
             logger.info(f"{name} is an alias for {dest}")
             return self.index[dest]
 
-    def get_dataset_list(self) -> List[str]:
+    def get_dataset_list(self):
         """Get list of indexed datasets"""
         return self.index.keys()
 
 
 dataset_index = DatasetIndex()
 
+# Datasets will in turn import dataset_index and register themselves in the index.
 import flarestack.data.public
 import flarestack.data.icecube