docs, typos

Author: MattToast

smartsim/_core/utils/helpers.py

@@ -64,11 +64,13 @@
 
 def unpack(value: _NestedJobSequenceType) -> t.Generator[Job, None, None]:
     """Unpack any iterable input in order to obtain a
-    single sequence of values
+    single sequence of values.
 
     :param value: Sequence containing elements of type Job or other
-    sequences that are also of type _NestedJobSequenceType
-    :return: flattened list of Jobs"""
+        sequences that are also of type `_NestedJobSequenceType`.
+    :raises TypeError: If the value is not a nested sequence of jobs.
+    :return: A flattened list of `Jobs`.
+    """
     from smartsim.launchable.job import Job
 
     for item in value:

smartsim/experiment.py

@@ -161,11 +161,10 @@ def start(self, *jobs: Job | t.Sequence[Job]) -> tuple[Record, ...]:
         """Execute a collection of `Job` instances.
 
         :param jobs: A collection of other job instances to start
-        :raises TypeError: If jobs provided are not the correct type
         :raises ValueError: No Jobs were provided.
-        :returns: A sequence of ids with order corresponding to the sequence of
-            jobs that can be used to query or alter the status of that
-            particular execution of the job.
+        :returns: A sequence of records with order corresponding to the
+            sequence of jobs that can be used to query or alter the status of
+            that particular execution of the job.
         """
 
         if not jobs:
@@ -232,12 +231,12 @@ def execute_dispatch(generator: Generator, job: Job, idx: int) -> LaunchedJobID:
         )
 
     def get_status(self, *records: Record) -> tuple[JobStatus | InvalidJobStatus, ...]:
-        """Get the status of jobs launched through the `Experiment` from their
-        launched job id returned when calling `Experiment.start`.
+        """Get the status of jobs launched through the `Experiment` from the
+        record returned when calling `Experiment.start`.
 
-        The `Experiment` will map the launched ID back to the launcher that
-        started the job and request a status update. The order of the returned
-        statuses exactly matches the order of the launched job ids.
+        The `Experiment` will map the launched id of the record back to the
+        launcher that started the job and request a status update. The order of
+        the returned statuses exactly matches the order of the records.
 
         If the `Experiment` cannot find any launcher that started the job
         associated with the launched job id, then a
@@ -450,7 +449,7 @@ def stop(self, *records: Record) -> tuple[JobStatus | InvalidJobStatus, ...]:
         """
         if not records:
             raise ValueError("No records provided")
-        if not all(isinstance(reocrd, Record) for reocrd in records):
+        if not all(isinstance(record, Record) for record in records):
             raise TypeError("record argument was not of type Record")
         ids = tuple(record.launched_id for record in records)
         by_launcher = self._launch_history.group_by_launcher(set(ids), unknown_ok=True)

smartsim/launchable/job.py

@@ -163,8 +163,8 @@ def __str__(self) -> str:  # pragma: no cover
 
 @t.final
 class Record:
-    """A record a job that was launched and launch ID assigned to the
-    launching.
+    """A Record object to track a launched job along with its assigned
+    launch ID.
     """
 
     def __init__(self, launch_id: LaunchedJobID, job: Job) -> None: