doc: error better documented

Author: Henri-ColibrITD

mpqp/core/instruction/measurement/pauli_string.py

@@ -458,14 +458,16 @@ class PauliStringAtom(PauliStringMonomial):
     """Represents a single Pauli operator acting on a qubit in a Pauli string.
 
     Args:
-        label: The label representing the Pauli operator (e.g., 'I', 'X', 'Y', 'Z').
+        label: The label representing the Pauli operator.
         matrix: The matrix representation of the Pauli operator.
 
     Raises:
-        AttributeError: new atoms cannot be created
+        RuntimeError: New atoms cannot be created, you should use the available
+            ones.
 
     Note:
-        All the atoms are already initialized. Available atoms are ('I', 'X', 'Y', 'Z').
+        All the atoms are already initialized. Available atoms are (``I``,
+        ``X``, ``Y``, ``Z``).
     """
 
     __is_mutable = True
@@ -476,8 +478,9 @@ def __init__(self, label: str, matrix: npt.NDArray[np.complex64]):
             self.matrix = matrix
             self.__is_mutable = False
         else:
-            raise AttributeError(
-                "New atoms cannot be created, just use the given I, X, Y and Z"
+            raise RuntimeError(
+                "New atoms cannot be created, just use the given `I`, `X`, `Y` "
+                "and `Z`"
             )
 
     @property

mpqp/execution/connection/ibm_connection.py

@@ -25,7 +25,7 @@ def config_ibm_account(token: str):
         token: IBM Quantum API token.
 
     Raises:
-        IBMRemoteExecutionError
+        IBMRemoteExecutionError: If the account could not be saved.
     """
     from qiskit_ibm_provider import IBMProvider
 
@@ -95,7 +95,8 @@ def get_IBMProvider() -> "IBMProvider":
     execution.
 
     Raises:
-        IBMRemoteExecutionError
+        IBMRemoteExecutionError: In the account was not properly configured
+            previously.
 
     Example:
         >>> instance = get_IBMProvider()
@@ -124,13 +125,13 @@ def get_IBMProvider() -> "IBMProvider":
             Ibm_Provider = IBMProvider()
         except RequestsApiError as err:
             raise IBMRemoteExecutionError(
-                "Error when instantiating IBM Provider (probably wrong token saved "
-                "in the account).\nTrace: " + str(err)
+                "Error when instantiating IBM Provider (probably wrong token "
+                "saved in the account).\nTrace: " + str(err)
             )
         except AccountNotFoundError as err:
             raise IBMRemoteExecutionError(
-                "Error when instantiating IBM Provider. No IBM Q account configured.\nTrace: "
-                + str(err)
+                "Error when instantiating IBM Provider. No IBM Q account "
+                "configured.\nTrace: " + str(err)
             )
     return Ibm_Provider
 

mpqp/execution/connection/qlm_connection.py

@@ -28,7 +28,7 @@ def config_qlm_account(username: str, password: str, global_config: bool) -> boo
             outside MPQP.
 
     Raises:
-        QLMRemoteExecutionError
+        QLMRemoteExecutionError: If the account could not be saved.
     """
     # store the username and password in environment variables QLM_USER and QLM_PASSWD in .mpqp
     prev_user = get_env_variable("QLM_USER")

mpqp/execution/devices.py

@@ -169,7 +169,8 @@ def from_str_remote(name: str):
             name: A string containing the name of the device.
 
         Raises:
-            ValueError
+            ValueError: If no device corresponding to the given name could be
+                found.
 
         Examples:
             >>> ATOSDevice.from_str_remote('NoisyQProc')