Correct names in docs (#174)

qiskit-community · May 2, 2024 · 0e0edcf · 0e0edcf
1 parent 9afe044
commit 0e0edcf
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 17 deletions.
diff --git a/qiskit_braket_provider/providers/braket_backend.py b/qiskit_braket_provider/providers/braket_backend.py
@@ -61,14 +61,14 @@ class BraketLocalBackend(BraketBackend):
     """BraketLocalBackend."""
 
     def __init__(self, name: str = "default", **fields):
-        """BraketLocalBackend for local execution of circuits.
+        """BraketLocalBackend for executing circuits locally.
 
         Example:
-            >>> device = LocalSimulator()                         #Local State Vector Simulator
-            >>> device = LocalSimulator("default")                #Local State Vector Simulator
-            >>> device = LocalSimulator(name="default")        #Local State Vector Simulator
-            >>> device = LocalSimulator(name="braket_sv")      #Local State Vector Simulator
-            >>> device = LocalSimulator(name="braket_dm")      #Local Density Matrix Simulator
+            >>> device = LocalSimulator()                    #Local State Vector Simulator
+            >>> device = LocalSimulator("default")           #Local State Vector Simulator
+            >>> device = LocalSimulator(name="default")      #Local State Vector Simulator
+            >>> device = LocalSimulator(name="braket_sv")    #Local State Vector Simulator
+            >>> device = LocalSimulator(name="braket_dm")    #Local Density Matrix Simulator
 
         Args:
             name: name of backend
@@ -183,7 +183,7 @@ def __init__(  # pylint: disable=too-many-arguments
         device: Optional[AwsDevice] = None,
         **fields,
     ):
-        """BraketAwsBackend for execution circuits against AWS Braket devices.
+        """BraketAwsBackend for executing circuits on Amazon Braket devices.
 
         Example:
             >>> provider = BraketProvider()

diff --git a/qiskit_braket_provider/providers/braket_provider.py b/qiskit_braket_provider/providers/braket_provider.py
@@ -18,12 +18,11 @@ class BraketProvider(ProviderV1):
         >>> provider = BraketProvider()
         >>> backends = provider.backends()
         >>> backends
-        [BraketBackend[Aspen-10],
-         BraketBackend[Aspen-11],
-         BraketBackend[Aspen-8],
-         BraketBackend[Aspen-9],
-         BraketBackend[Aspen-M-1],
-         BraketBackend[IonQ Device],
+        [BraketBackend[Aria 1],
+         BraketBackend[Aria 2],
+         BraketBackend[Aspen-M-3],
+         BraketBackend[Forte 1],
+         BraketBackend[Harmony],
          BraketBackend[Lucy],
          BraketBackend[SV1],
          BraketBackend[TN1],

diff --git a/qiskit_braket_provider/providers/braket_quantum_task.py b/qiskit_braket_provider/providers/braket_quantum_task.py
@@ -17,7 +17,7 @@ def retry_if_result_none(result):
     return result is None
 
 
-def _get_result_from_aws_tasks(
+def _get_result_from_tasks(
     tasks: Union[List[LocalQuantumTask], List[AwsQuantumTask]],
 ) -> Optional[List[ExperimentResult]]:
     """Returns experiment results of AWS tasks.
@@ -78,7 +78,7 @@ def _get_result_from_aws_tasks(
 
 
 class BraketQuantumTask(JobV1):
-    """BraketTask."""
+    """BraketQuantumTask."""
 
     def __init__(
         self,
@@ -87,7 +87,7 @@ def __init__(
         tasks: Union[List[LocalQuantumTask], List[AwsQuantumTask]],
         **metadata: Optional[dict],
     ):
-        """BraketTask for execution of circuits on Amazon Braket or locally.
+        """BraketQuantumTask for execution of circuits on Amazon Braket or locally.
 
         Args:
             task_id: Semicolon-separated IDs of the underlying tasks
@@ -159,7 +159,7 @@ def task_id(self) -> str:
         return self._task_id
 
     def result(self) -> Result:
-        experiment_results = _get_result_from_aws_tasks(tasks=self._tasks)
+        experiment_results = _get_result_from_tasks(tasks=self._tasks)
         status = self.status(use_cached_value=True)
 
         return Result(