Merge pull request #51 from lsst-sqre/tickets/DM-37516

DM-37516: Update docstring syntax around types
lsst-sqre · Jan 13, 2023 · 01d025d · 01d025d
2 parents 1bb2484 + 04ac983
commit 01d025d
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/src/crawlspace/exceptions.py b/src/crawlspace/exceptions.py
@@ -8,7 +8,7 @@ class GCSFileNotFoundError(Exception):
 
     Parameters
     ----------
-    path : `str`
+    path
         Bucket path that was not found.
     """
 

diff --git a/src/crawlspace/services/file.py b/src/crawlspace/services/file.py
@@ -32,9 +32,9 @@ def from_blob(cls, path: str, blob: storage.Blob) -> CrawlspaceFile:
 
         Parameters
         ----------
-        path : `str`
+        path
             Path to the file.
-        blob : `google.cloud.storage.Blob`
+        blob
             Underlying Google Cloud Storage blob.
         """
         headers = {
@@ -70,7 +70,7 @@ class FileService:
 
     Parameters
     ----------
-    gcs : `google.cloud.storage.Client`
+    gcs
         Google Cloud Storage client to use to retrieve the file and its
         metadata.
     """
@@ -86,7 +86,7 @@ def get_file(self, path: str) -> CrawlspaceFile:
 
         Parameters
         ----------
-        path : `str`
+        path
             Path to the file.
 
         Raises
-Original file line number
+Diff line change
@@ Expand Up / @@ -8,7 +8,7 @@ class GCSFileNotFoundError(Exception): @@
         Parameters
         ----------
-        path : `str`
+        path
             Bucket path that was not found.
         """
@@ Expand Down @@