Merge pull request #883 from adamtheturtle/document-raises

Document raises UnknownTarget

Author: adamtheturtle

spelling_private_dict.txt

@@ -1,4 +1,5 @@
 Ubuntu
+UnknownTarget
 api
 args
 ascii

src/vws/vws.py

@@ -242,6 +242,10 @@ def get_target_record(self, target_id: str) -> Dict[str, Union[str, int]]:
 
         Returns:
             Response details of a target from Vuforia.
+
+        Raises:
+            ~vws.exceptions.UnknownTarget: The given target ID does not match a
+                target in the database.
         """
         response = self._make_request(
             method='GET',
@@ -264,6 +268,8 @@ def wait_for_target_processed(self, target_id: str) -> None:
         Raises:
             TimeoutError: The target remained in the processing stage for more
                 than five minutes.
+            ~vws.exceptions.UnknownTarget: The given target ID does not match a
+                target in the database.
         """
         while True:
             report = self.get_target_summary_report(target_id=target_id)
@@ -309,6 +315,10 @@ def get_target_summary_report(
 
         Returns:
             Details of the target.
+
+        Raises:
+            ~vws.exceptions.UnknownTarget: The given target ID does not match a
+                target in the database.
         """
         response = self._make_request(
             method='GET',
@@ -347,6 +357,10 @@ def delete_target(self, target_id: str) -> None:
 
         Args:
             target_id: The ID of the target to delete.
+
+        Raises:
+            ~vws.exceptions.UnknownTarget: The given target ID does not match a
+                target in the database.
         """
         self._make_request(
             method='DELETE',