Fill in docstring placeholders

DataDog · Jul 25, 2024 · c459557 · c459557
1 parent 2ebec07
commit c459557
Showing 1 changed file with 10 additions and 6 deletions.
diff --git a/guarddog/scanners/__init__.py b/guarddog/scanners/__init__.py
@@ -12,13 +12,15 @@
 
 def get_package_scanner(ecosystem: ECOSYSTEM) -> Optional[PackageScanner]:
     """
-    TODO
+    Return a `PackageScanner` for the given ecosystem or `None` if it
+    is not yet supported.
 
     Args:
-        ecosystem (ECOSYSTEM): TODO
+        ecosystem (ECOSYSTEM): The ecosystem of the desired scanner
 
     Returns:
-        Optional[PackageScanner]: TODO
+        Optional[PackageScanner]: The result of the scanner request
+
     """
     match ecosystem:
         case ECOSYSTEM.PYPI:
@@ -32,13 +34,15 @@ def get_package_scanner(ecosystem: ECOSYSTEM) -> Optional[PackageScanner]:
 
 def get_project_scanner(ecosystem: ECOSYSTEM) -> Optional[ProjectScanner]:
     """
-    TODO
+    Return a `ProjectScanner` for the given ecosystem or `None` if
+    it is not yet supported.
 
     Args:
-        ecosystem (ECOSYSTEM): TODO
+        ecosystem (ECOSYSTEM): The ecosystem of the desired scanner
 
     Returns:
-        Optional[ProjectScanner]: TODO
+        Optional[ProjectScanner]: The result of the scanner request
+
     """
     match ecosystem:
         case ECOSYSTEM.PYPI: