docstring fixes

lsst-sqre · Jun 7, 2024 · d805b89 · d805b89
1 parent 7919c8c
commit d805b89
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 14 deletions.
diff --git a/src/sasquatchbackpack/sasquatch.py b/src/sasquatchbackpack/sasquatch.py
@@ -70,7 +70,7 @@ def create_topic(self) -> str:
 
         Returns
         -------
-        response text
+        str
             The results of the POST request in string format
         """
         headers = {"content-type": "application/json"}
@@ -107,7 +107,7 @@ def post(self) -> str:
 
         Returns
         -------
-        response text
+        str
             The results of the POST request in string format
         """
         records = self.source.get_records()

diff --git a/src/sasquatchbackpack/sources.py b/src/sasquatchbackpack/sources.py
@@ -15,7 +15,7 @@ class DataSource(ABC):
 
     Parameters
     ----------
-    topic name
+    str
         Specific source name, used as an identifier
     """
 
@@ -38,19 +38,19 @@ class USGSConfig:
 
     Parameters
     ----------
-    duration
+    timedelta
         How far back from the present should be searched
-    radius
-        Padius of search from central coordinates in km
-    coords
+    int
+        Radius of search from central coordinates in km
+    tuple[float,float]
         latitude and longitude of the central coordnates
         (latitude, longitude)
-    magnitude bounds
+    tuple[int, int]
         upper and lower bounds for magnitude search (lower, upper)
-    schema file
+    str
         Directory path to the relevant source schema
-        ("src/sasquatchbackpack/schemas/*.avsc"), optional,
-        defaults to "src/sasquatchbackpack/schemas/usgs.avsc"
+        (src/sasquatchbackpack/schemas/schema_name_here.avsc), optional,
+        defaults to src/sasquatchbackpack/schemas/usgs.avsc
     """
 
     duration: timedelta
@@ -65,10 +65,10 @@ class USGSSource(DataSource):
 
     Parameters
     ----------
-    config
+    USGSconfig
         USGSConfig to transmit relevant information to
         the Source
-    topic name
+    str
         Specific source name, used as an identifier
     """
 
@@ -96,7 +96,7 @@ def get_records(self) -> list:
 
         Returns
         -------
-        records
+        list
             A payload consisting of a list of dictionaries,
             each containing data about a specific earthquake
             in the build results.