Skip to content

Commit

Permalink
Regeneration of API docs with modifiers (#1340)
Browse files Browse the repository at this point in the history 
Part of  #1287
Follow-up of #1337

This PR regenerates the API docs incorporating the changes of #1337.
This is split into two PRs to help in the review of the changes to the
script and due to the amount of files modified. Here we can find all
versions except qiskit 1.0 which was generated in #1337 to review it
more exhaustively.

This change should be merged after changing the MDX components on IQP to
support the new prop.
  • Loading branch information
@arnaucasau
arnaucasau authored May 13, 2024
1 parent bb39ba7 commit c903961
Show file tree
Hide file tree
Showing 19,303 changed files with 48,914 additions and 48,914 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
4 changes: 2 additions & 2 deletions docs/api/qiskit-ibm-provider/0.10/ibm_utils.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Message broker for the Publisher / Subscriber mechanism

### Publisher

<Class id="qiskit_ibm_provider.utils.pubsub.Publisher" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/utils/pubsub.py#L140-L155" signature="Publisher">
<Class id="qiskit_ibm_provider.utils.pubsub.Publisher" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/utils/pubsub.py#L140-L155" signature="Publisher" modifiers="class">
Represents a “publisher”.

Every component (class) can become a [`Publisher`](#qiskit_ibm_provider.utils.pubsub.Publisher "qiskit_ibm_provider.utils.pubsub.Publisher") and send events by inheriting this class. Functions can call this class like:
Expand All @@ -66,7 +66,7 @@ Message broker for the Publisher / Subscriber mechanism

### Subscriber

<Class id="qiskit_ibm_provider.utils.pubsub.Subscriber" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/utils/pubsub.py#L158-L182" signature="Subscriber">
<Class id="qiskit_ibm_provider.utils.pubsub.Subscriber" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/utils/pubsub.py#L158-L182" signature="Subscriber" modifiers="class">
Represents a “subscriber”.

Every component (class) can become a [`Subscriber`](#qiskit_ibm_provider.utils.pubsub.Subscriber "qiskit_ibm_provider.utils.pubsub.Subscriber") and subscribe to events, that will call callback functions when they are emitted.
Expand Down
4 changes: 2 additions & 2 deletions docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackend.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMBackend

# IBMBackend

<Class id="qiskit_ibm_provider.IBMBackend" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_backend.py#L79-L895" signature="IBMBackend(configuration, provider, api_client, instance=None)">
<Class id="qiskit_ibm_provider.IBMBackend" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_backend.py#L79-L895" signature="IBMBackend(configuration, provider, api_client, instance=None)" modifiers="class">
Backend class interfacing with an IBM Quantum device.

You can run experiments on a backend using the [`run()`](#qiskit_ibm_provider.IBMBackend.run "qiskit_ibm_provider.IBMBackend.run") method. The [`run()`](#qiskit_ibm_provider.IBMBackend.run "qiskit_ibm_provider.IBMBackend.run") method takes one or more [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.0)") and returns an `IBMJob` instance that represents the submitted job. Each job has a unique job ID, which can later be used to retrieve the job. An example of this flow:
Expand Down Expand Up @@ -423,7 +423,7 @@ python_api_name: qiskit_ibm_provider.IBMBackend

### get\_translation\_stage\_plugin

<Function id="qiskit_ibm_provider.IBMBackend.get_translation_stage_plugin" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_backend.py#L802-L805" signature="classmethod get_translation_stage_plugin()">
<Function id="qiskit_ibm_provider.IBMBackend.get_translation_stage_plugin" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_backend.py#L802-L805" signature="get_translation_stage_plugin()" modifiers="classmethod">
Return the default translation stage plugin name for IBM backends.

**Return type**
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackendApiError.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendApiError

# IBMBackendApiError

<Class id="qiskit_ibm_provider.IBMBackendApiError" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py#L78-L81" signature="IBMBackendApiError(*message)">
<Class id="qiskit_ibm_provider.IBMBackendApiError" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py#L78-L81" signature="IBMBackendApiError(*message)" modifiers="exception">
Errors that occur unexpectedly when querying the server.

Set the error message.
Expand Down
2 changes: 1 addition & 1 deletion ...api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackendApiProtocolError.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendApiProtocolError

# IBMBackendApiProtocolError

<Class id="qiskit_ibm_provider.IBMBackendApiProtocolError" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py#L84-L87" signature="IBMBackendApiProtocolError(*message)">
<Class id="qiskit_ibm_provider.IBMBackendApiProtocolError" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py#L84-L87" signature="IBMBackendApiProtocolError(*message)" modifiers="exception">
Errors raised when an unexpected value is received from the server.

Set the error message.
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackendError.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendError

# IBMBackendError

<Class id="qiskit_ibm_provider.IBMBackendError" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py#L72-L75" signature="IBMBackendError(*message)">
<Class id="qiskit_ibm_provider.IBMBackendError" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py#L72-L75" signature="IBMBackendError(*message)" modifiers="exception">
Base class for errors raised by the backend modules.

Set the error message.
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackendService.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendService

# IBMBackendService

<Class id="qiskit_ibm_provider.IBMBackendService" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_backend_service.py#L61-L741" signature="IBMBackendService(provider, hgp)">
<Class id="qiskit_ibm_provider.IBMBackendService" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_backend_service.py#L61-L741" signature="IBMBackendService(provider, hgp)" modifiers="class">
Backend namespace for an IBM Quantum account.

Represent a namespace that provides backend related services for the IBM Quantum backends available to this account. An instance of this class is used as a callable attribute to the [`IBMProvider`](qiskit_ibm_provider.IBMProvider "qiskit_ibm_provider.IBMProvider") class. This allows a convenient way to query for all backends or to access a specific backend:
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackendValueError.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendValueError

# IBMBackendValueError

<Class id="qiskit_ibm_provider.IBMBackendValueError" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py#L90-L93" signature="IBMBackendValueError(*message)">
<Class id="qiskit_ibm_provider.IBMBackendValueError" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py#L90-L93" signature="IBMBackendValueError(*message)" modifiers="exception">
Value errors raised by the backend modules.

Set the error message.
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMError.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMError

# IBMError

<Class id="qiskit_ibm_provider.IBMError" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py#L18-L21" signature="IBMError(*message)">
<Class id="qiskit_ibm_provider.IBMError" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py#L18-L21" signature="IBMError(*message)" modifiers="exception">
Base class for errors raised by the provider modules.

Set the error message.
Expand Down
8 changes: 4 additions & 4 deletions docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMProvider.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMProvider

# IBMProvider

<Class id="qiskit_ibm_provider.IBMProvider" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_provider.py#L46-L671" signature="IBMProvider(token=None, url=None, name=None, instance=None, proxies=None, verify=None)">
<Class id="qiskit_ibm_provider.IBMProvider" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_provider.py#L46-L671" signature="IBMProvider(token=None, url=None, name=None, instance=None, proxies=None, verify=None)" modifiers="class">
Provides access to the IBM Quantum services available to an account.

Authenticate against IBM Quantum for use from saved credentials or during session.
Expand Down Expand Up @@ -190,7 +190,7 @@ python_api_name: qiskit_ibm_provider.IBMProvider

### delete\_account

<Function id="qiskit_ibm_provider.IBMProvider.delete_account" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_provider.py#L445-L456" signature="static delete_account(name=None)">
<Function id="qiskit_ibm_provider.IBMProvider.delete_account" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_provider.py#L445-L456" signature="delete_account(name=None)" modifiers="static">
Delete a saved account from disk.

**Parameters**
Expand Down Expand Up @@ -296,7 +296,7 @@ python_api_name: qiskit_ibm_provider.IBMProvider

### save\_account

<Function id="qiskit_ibm_provider.IBMProvider.save_account" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_provider.py#L458-L494" signature="static save_account(token=None, url=None, instance=None, name=None, proxies=None, verify=None, overwrite=False)">
<Function id="qiskit_ibm_provider.IBMProvider.save_account" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_provider.py#L458-L494" signature="save_account(token=None, url=None, instance=None, name=None, proxies=None, verify=None, overwrite=False)" modifiers="static">
Save the account to disk for future use.

**Parameters**
Expand All @@ -316,7 +316,7 @@ python_api_name: qiskit_ibm_provider.IBMProvider

### saved\_accounts

<Function id="qiskit_ibm_provider.IBMProvider.saved_accounts" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_provider.py#L496-L521" signature="static saved_accounts(default=None, name=None)">
<Function id="qiskit_ibm_provider.IBMProvider.saved_accounts" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_provider.py#L496-L521" signature="saved_accounts(default=None, name=None)" modifiers="static">
List the accounts saved on disk.

**Parameters**
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMProviderError.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMProviderError

# IBMProviderError

<Class id="qiskit_ibm_provider.IBMProviderError" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py#L30-L33" signature="IBMProviderError(*message)">
<Class id="qiskit_ibm_provider.IBMProviderError" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py#L30-L33" signature="IBMProviderError(*message)" modifiers="exception">
Base class for errors raise by IBMProvider.

Set the error message.
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMProviderValueError.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMProviderValueError

# IBMProviderValueError

<Class id="qiskit_ibm_provider.IBMProviderValueError" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py#L36-L39" signature="IBMProviderValueError(*message)">
<Class id="qiskit_ibm_provider.IBMProviderValueError" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/exceptions.py#L36-L39" signature="IBMProviderValueError(*message)" modifiers="exception">
Value errors raised by IBMProvider.

Set the error message.
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.Session.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.Session

# Session

<Class id="qiskit_ibm_provider.Session" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/session.py#L22-L123" signature="Session(max_time=None, session_id=None)">
<Class id="qiskit_ibm_provider.Session" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/session.py#L22-L123" signature="Session(max_time=None, session_id=None)" modifiers="class">
Class for creating a flexible Qiskit Runtime session.

A Qiskit Runtime `session` allows you to group a collection of iterative calls to the quantum computer. A session is started when the first job within the session is started. Subsequent jobs within the session are prioritized by the scheduler. Data used within a session, such as transpiled circuits, is also cached to avoid unnecessary overhead.
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMCircuitJob.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.job.IBMCircuitJob

# IBMCircuitJob

<Class id="qiskit_ibm_provider.job.IBMCircuitJob" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/job/ibm_circuit_job.py#L59-L860" signature="IBMCircuitJob(backend, api_client, job_id, creation_date=None, status=None, runtime_client=None, kind=None, name=None, time_per_step=None, result=None, error=None, session_id=None, tags=None, run_mode=None, client_info=None, **kwargs)">
<Class id="qiskit_ibm_provider.job.IBMCircuitJob" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/job/ibm_circuit_job.py#L59-L860" signature="IBMCircuitJob(backend, api_client, job_id, creation_date=None, status=None, runtime_client=None, kind=None, name=None, time_per_step=None, result=None, error=None, session_id=None, tags=None, run_mode=None, client_info=None, **kwargs)" modifiers="class">
Representation of a job that executes on an IBM Quantum backend.

The job may be executed on a simulator or a real device. A new `IBMCircuitJob` instance is returned when you call `IBMBackend.run()` to submit a job to a particular backend.
Expand Down
4 changes: 2 additions & 2 deletions docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMCompositeJob.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.job.IBMCompositeJob

# IBMCompositeJob

<Class id="qiskit_ibm_provider.job.IBMCompositeJob" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/job/ibm_composite_job.py#L72-L1317" signature="IBMCompositeJob(backend, api_client, job_id=None, creation_date=None, jobs=None, circuits_list=None, run_config=None, name=None, tags=None, client_version=None)">
<Class id="qiskit_ibm_provider.job.IBMCompositeJob" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/job/ibm_composite_job.py#L72-L1317" signature="IBMCompositeJob(backend, api_client, job_id=None, creation_date=None, jobs=None, circuits_list=None, run_config=None, name=None, tags=None, client_version=None)" modifiers="class">
Representation of a set of jobs that execute on an IBM Quantum backend.

An `IBMCompositeJob` instance is returned when you call `IBMBackend.run()` to submit a list of circuits whose length exceeds the maximum allowed by the backend or by the `max_circuits_per_job` parameter.
Expand Down Expand Up @@ -192,7 +192,7 @@ python_api_name: qiskit_ibm_provider.job.IBMCompositeJob

### from\_jobs

<Function id="qiskit_ibm_provider.job.IBMCompositeJob.from_jobs" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/job/ibm_composite_job.py#L224-L255" signature="classmethod from_jobs(job_id, jobs, api_client)">
<Function id="qiskit_ibm_provider.job.IBMCompositeJob.from_jobs" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/job/ibm_composite_job.py#L224-L255" signature="from_jobs(job_id, jobs, api_client)" modifiers="classmethod">
Return an instance of this class.

The input job ID is used to query for sub-job information from the server.
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMJobApiError.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.job.IBMJobApiError

# IBMJobApiError

<Class id="qiskit_ibm_provider.job.IBMJobApiError" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/job/exceptions.py#L26-L29" signature="IBMJobApiError(*message)">
<Class id="qiskit_ibm_provider.job.IBMJobApiError" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/job/exceptions.py#L26-L29" signature="IBMJobApiError(*message)" modifiers="exception">
Errors that occur unexpectedly when querying the server.

Set the error message.
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMJobError.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.job.IBMJobError

# IBMJobError

<Class id="qiskit_ibm_provider.job.IBMJobError" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/job/exceptions.py#L20-L23" signature="IBMJobError(*message)">
<Class id="qiskit_ibm_provider.job.IBMJobError" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/job/exceptions.py#L20-L23" signature="IBMJobError(*message)" modifiers="exception">
Base class for errors raised by the job modules.

Set the error message.
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMJobFailureError.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.job.IBMJobFailureError

# IBMJobFailureError

<Class id="qiskit_ibm_provider.job.IBMJobFailureError" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/job/exceptions.py#L32-L35" signature="IBMJobFailureError(*message)">
<Class id="qiskit_ibm_provider.job.IBMJobFailureError" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/job/exceptions.py#L32-L35" signature="IBMJobFailureError(*message)" modifiers="exception">
Errors raised when a job failed.

Set the error message.
Expand Down
2 changes: 1 addition & 1 deletion ...pi/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMJobInvalidStateError.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.job.IBMJobInvalidStateError

# IBMJobInvalidStateError

<Class id="qiskit_ibm_provider.job.IBMJobInvalidStateError" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/job/exceptions.py#L38-L41" signature="IBMJobInvalidStateError(*message)">
<Class id="qiskit_ibm_provider.job.IBMJobInvalidStateError" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/job/exceptions.py#L38-L41" signature="IBMJobInvalidStateError(*message)" modifiers="exception">
Errors raised when a job is not in a valid state for the operation.

Set the error message.
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMJobTimeoutError.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.job.IBMJobTimeoutError

# IBMJobTimeoutError

<Class id="qiskit_ibm_provider.job.IBMJobTimeoutError" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/job/exceptions.py#L44-L47" signature="IBMJobTimeoutError(*message)">
<Class id="qiskit_ibm_provider.job.IBMJobTimeoutError" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/job/exceptions.py#L44-L47" signature="IBMJobTimeoutError(*message)" modifiers="exception">
Errors raised when a job operation times out.

Set the error message.
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.QueueInfo.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.job.QueueInfo

# QueueInfo

<Class id="qiskit_ibm_provider.job.QueueInfo" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/job/queueinfo.py#L25-L183" signature="QueueInfo(position_in_queue=None, status=None, estimated_start_time=None, estimated_completion_time=None, hub_priority=None, group_priority=None, project_priority=None, job_id=None, **kwargs)">
<Class id="qiskit_ibm_provider.job.QueueInfo" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/job/queueinfo.py#L25-L183" signature="QueueInfo(position_in_queue=None, status=None, estimated_start_time=None, estimated_completion_time=None, hub_priority=None, group_priority=None, project_priority=None, job_id=None, **kwargs)" modifiers="class">
Queue information for a job.

QueueInfo constructor.
Expand Down
Loading

0 comments on commit c903961

Please sign in to comment.