Tweak comments per review

Co-authored-by: Tim Jenness <[email protected]>
lsst · Dec 7, 2023 · 9ef02ce · 9ef02ce
1 parent df37fd1
commit 9ef02ce
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 9 deletions.
diff --git a/python/lsst/daf/butler/datastore/stored_file_info.py b/python/lsst/daf/butler/datastore/stored_file_info.py
@@ -215,7 +215,7 @@ def __init__(
     """StorageClass associated with Dataset."""
 
     component: str | None
-    """Component associated with this file. Can be None if the file does
+    """Component associated with this file. Can be `None` if the file does
     not refer to a component of a composite."""
 
     checksum: str | None
@@ -347,7 +347,7 @@ class SerializedStoredFileInfo(_BaseModelCompat):
     """Name of the StorageClass associated with Dataset."""
 
     component: str | None
-    """Component associated with this file. Can be None if the file does
+    """Component associated with this file. Can be `None` if the file does
     not refer to a component of a composite."""
 
     checksum: str | None

diff --git a/python/lsst/daf/butler/datastores/fileDatastoreClient.py b/python/lsst/daf/butler/datastores/fileDatastoreClient.py
@@ -57,11 +57,12 @@ def get_dataset_as_python_object(
     Parameters
     ----------
     payload : `FileDatastoreGetPayload`
-        Pre-processed information about each file associated with this artifact
+        Pre-processed information about each file associated with this
+        artifact.
     universe: `DimensionUniverse`
         The universe of dimensions associated with the `DatasetRef` contained
-        in `payload`.
-    parameters : `Mapping`[`str`, `Any`]
+        in ``payload``.
+    parameters : `Mapping`[`str`, `typing.Any`]
         `StorageClass` and `Formatter` parameters to be used when converting
         the artifact to a Python object
     storageClass: `StorageClass` | `str` | `None`

diff --git a/python/lsst/daf/butler/datastores/file_datastore/get.py b/python/lsst/daf/butler/datastores/file_datastore/get.py
@@ -102,7 +102,7 @@ def generate_datastore_get_information(
 
     Returns
     -------
-    getInfo : `list[DatastoreFileGetInformation]`
+    getInfo : `list` [`DatastoreFileGetInformation`]
         The parameters needed to retrieve each file
     """
     if readStorageClass is None:
@@ -349,14 +349,14 @@ def get_dataset_as_python_object_from_get_info(
         The registry information associated with this artifact.
     parameters : `Mapping`[`str`, `Any`]
         `StorageClass` and `Formatter` parameters
-    cache_manager: `AbstractDatastoreCacheManager`
+    cache_manager : `AbstractDatastoreCacheManager`
         The cache manager to use for caching retrieved files
 
     Returns
     -------
-    python_object: `Any`
+    python_object : `typing.Any`
         The retrieved artifact, converted to a Python object according to the
-        `StorageClass` specified in `ref`.
+        `StorageClass` specified in ``ref``.
     """
     refStorageClass = ref.datasetType.storageClass
     refComponent = ref.datasetType.component()