Skip to content

Commit

Permalink
Remove name attribute from API components (Qiskit#1284)
Browse files Browse the repository at this point in the history 
Closes Qiskit#1281.
  • Loading branch information
@Eric-Arellano
Eric-Arellano authored May 2, 2024
1 parent a44f5aa commit 07bf499
Show file tree
Hide file tree
Showing 26,085 changed files with 287,446 additions and 287,460 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
8 changes: 4 additions & 4 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 @@ -53,7 +53,7 @@ Message broker for the Publisher / Subscriber mechanism

### publish

<Function id="qiskit_ibm_provider.utils.pubsub.Publisher.publish" name="publish" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/utils/pubsub.py#L152-L155" signature="publish(event, *args, **kwargs)">
<Function id="qiskit_ibm_provider.utils.pubsub.Publisher.publish" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/utils/pubsub.py#L152-L155" signature="publish(event, *args, **kwargs)">
Triggers an event, and associates some data to it, so if there are any subscribers, their callback will be called synchronously.

**Return type**
Expand All @@ -69,7 +69,7 @@ Message broker for the Publisher / Subscriber mechanism

### clear

<Function id="qiskit_ibm_provider.utils.pubsub.Subscriber.clear" name="clear" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/utils/pubsub.py#L180-L182" signature="clear()">
<Function id="qiskit_ibm_provider.utils.pubsub.Subscriber.clear" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/utils/pubsub.py#L180-L182" signature="clear()">
Unsubscribe everything

**Return type**
Expand All @@ -79,7 +79,7 @@ Message broker for the Publisher / Subscriber mechanism

### subscribe

<Function id="qiskit_ibm_provider.utils.pubsub.Subscriber.subscribe" name="subscribe" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/utils/pubsub.py#L168-L173" signature="subscribe(event, callback)">
<Function id="qiskit_ibm_provider.utils.pubsub.Subscriber.subscribe" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/utils/pubsub.py#L168-L173" signature="subscribe(event, callback)">
Subscribes to an event, associating a callback function to that event, so when the event occurs, the callback will be called.

This is a blocking call, so try to keep callbacks as lightweight as possible.
Expand All @@ -91,7 +91,7 @@ Message broker for the Publisher / Subscriber mechanism

### unsubscribe

<Function id="qiskit_ibm_provider.utils.pubsub.Subscriber.unsubscribe" name="unsubscribe" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/utils/pubsub.py#L175-L178" signature="unsubscribe(event, callback)">
<Function id="qiskit_ibm_provider.utils.pubsub.Subscriber.unsubscribe" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/utils/pubsub.py#L175-L178" signature="unsubscribe(event, callback)">
Unsubscribe a pair event-callback, so the callback will not be called anymore when the event occurs.

**Return type**
Expand Down
74 changes: 37 additions & 37 deletions docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackend.mdx
View file

Large diffs are not rendered by default.

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" name="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)">
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" name="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)">
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" name="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)">
Base class for errors raised by the backend modules.

Set the error message.
Expand Down
6 changes: 3 additions & 3 deletions 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 @@ -41,7 +41,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendService

### backends

<Function id="qiskit_ibm_provider.IBMBackendService.backends" name="backends" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_backend_service.py#L118-L218" signature="backends(name=None, filters=None, min_num_qubits=None, instance=None, dynamic_circuits=None, **kwargs)">
<Function id="qiskit_ibm_provider.IBMBackendService.backends" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_backend_service.py#L118-L218" signature="backends(name=None, filters=None, min_num_qubits=None, instance=None, dynamic_circuits=None, **kwargs)">
Return all backends accessible via this account, subject to optional filtering.

**Parameters**
Expand Down Expand Up @@ -96,7 +96,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendService

### jobs

<Function id="qiskit_ibm_provider.IBMBackendService.jobs" name="jobs" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_backend_service.py#L220-L368" signature="jobs(limit=10, skip=0, backend_name=None, status=None, start_datetime=None, end_datetime=None, job_tags=None, descending=True, instance=None, legacy=False)">
<Function id="qiskit_ibm_provider.IBMBackendService.jobs" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_backend_service.py#L220-L368" signature="jobs(limit=10, skip=0, backend_name=None, status=None, start_datetime=None, end_datetime=None, job_tags=None, descending=True, instance=None, legacy=False)">
Return a list of jobs, subject to optional filtering.

Retrieve jobs that match the given filters and paginate the results if desired. Note that the server has a limit for the number of jobs returned in a single call. As a result, this function might involve making several calls to the server.
Expand Down Expand Up @@ -134,7 +134,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendService

### retrieve\_job

<Function id="qiskit_ibm_provider.IBMBackendService.retrieve_job" name="retrieve_job" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_backend_service.py#L621-L662" signature="retrieve_job(job_id)">
<Function id="qiskit_ibm_provider.IBMBackendService.retrieve_job" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_backend_service.py#L621-L662" signature="retrieve_job(job_id)">
Return a single job.

**Parameters**
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" name="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)">
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" name="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)">
Base class for errors raised by the provider modules.

Set the error message.
Expand Down
22 changes: 11 additions & 11 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 @@ -110,7 +110,7 @@ python_api_name: qiskit_ibm_provider.IBMProvider

### backend

<Attribute id="qiskit_ibm_provider.IBMProvider.backend" name="backend">
<Attribute id="qiskit_ibm_provider.IBMProvider.backend">
Return the backend service.

**Return type**
Expand All @@ -124,13 +124,13 @@ python_api_name: qiskit_ibm_provider.IBMProvider

### version

<Attribute id="qiskit_ibm_provider.IBMProvider.version" name="version" attributeValue="1" />
<Attribute id="qiskit_ibm_provider.IBMProvider.version" attributeValue="1" />

## Methods

### active\_account

<Function id="qiskit_ibm_provider.IBMProvider.active_account" name="active_account" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_provider.py#L426-L435" signature="active_account()">
<Function id="qiskit_ibm_provider.IBMProvider.active_account" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_provider.py#L426-L435" signature="active_account()">
Return the IBM Quantum account currently in use for the session.

**Return type**
Expand All @@ -144,7 +144,7 @@ python_api_name: qiskit_ibm_provider.IBMProvider

### backends

<Function id="qiskit_ibm_provider.IBMProvider.backends" name="backends" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_provider.py#L523-L567" signature="backends(name=None, filters=None, min_num_qubits=None, instance=None, **kwargs)">
<Function id="qiskit_ibm_provider.IBMProvider.backends" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_provider.py#L523-L567" signature="backends(name=None, filters=None, min_num_qubits=None, instance=None, **kwargs)">
Return all backends accessible via this account, subject to optional filtering.

**Parameters**
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" name="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="static delete_account(name=None)">
Delete a saved account from disk.

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

### get\_backend

<Function id="qiskit_ibm_provider.IBMProvider.get_backend" name="get_backend" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_provider.py#L637-L668" signature="get_backend(name=None, instance=None, **kwargs)">
<Function id="qiskit_ibm_provider.IBMProvider.get_backend" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_provider.py#L637-L668" signature="get_backend(name=None, instance=None, **kwargs)">
Return a single backend matching the specified filtering.

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

### instances

<Function id="qiskit_ibm_provider.IBMProvider.instances" name="instances" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_provider.py#L437-L443" signature="instances()">
<Function id="qiskit_ibm_provider.IBMProvider.instances" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_provider.py#L437-L443" signature="instances()">
Return the IBM Quantum instances list currently in use for the session.

**Return type**
Expand All @@ -247,7 +247,7 @@ python_api_name: qiskit_ibm_provider.IBMProvider

### jobs

<Function id="qiskit_ibm_provider.IBMProvider.jobs" name="jobs" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_provider.py#L569-L624" signature="jobs(limit=10, skip=0, backend_name=None, status=None, start_datetime=None, end_datetime=None, job_tags=None, descending=True, instance=None, legacy=False)">
<Function id="qiskit_ibm_provider.IBMProvider.jobs" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_provider.py#L569-L624" signature="jobs(limit=10, skip=0, backend_name=None, status=None, start_datetime=None, end_datetime=None, job_tags=None, descending=True, instance=None, legacy=False)">
Return a list of jobs, subject to optional filtering.

Retrieve jobs that match the given filters and paginate the results if desired. Note that the server has a limit for the number of jobs returned in a single call. As a result, this function might involve making several calls to the server.
Expand Down Expand Up @@ -278,7 +278,7 @@ python_api_name: qiskit_ibm_provider.IBMProvider

### retrieve\_job

<Function id="qiskit_ibm_provider.IBMProvider.retrieve_job" name="retrieve_job" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_provider.py#L626-L635" signature="retrieve_job(job_id)">
<Function id="qiskit_ibm_provider.IBMProvider.retrieve_job" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/ibm_provider.py#L626-L635" signature="retrieve_job(job_id)">
Return a single job.

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

### save\_account

<Function id="qiskit_ibm_provider.IBMProvider.save_account" name="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="static save_account(token=None, url=None, instance=None, name=None, proxies=None, verify=None, overwrite=False)">
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" name="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="static saved_accounts(default=None, name=None)">
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" name="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)">
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" name="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)">
Value errors raised by IBMProvider.

Set the error message.
Expand Down
6 changes: 3 additions & 3 deletions 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 @@ -47,7 +47,7 @@ python_api_name: qiskit_ibm_provider.Session

### active

<Attribute id="qiskit_ibm_provider.Session.active" name="active">
<Attribute id="qiskit_ibm_provider.Session.active">
Return the status of the session.

**Return type**
Expand All @@ -61,7 +61,7 @@ python_api_name: qiskit_ibm_provider.Session

### session\_id

<Attribute id="qiskit_ibm_provider.Session.session_id" name="session_id">
<Attribute id="qiskit_ibm_provider.Session.session_id">
Return the session ID.

**Return type**
Expand All @@ -77,7 +77,7 @@ python_api_name: qiskit_ibm_provider.Session

### cancel

<Function id="qiskit_ibm_provider.Session.cancel" name="cancel" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/session.py#L109-L111" signature="cancel()">
<Function id="qiskit_ibm_provider.Session.cancel" github="https://github.com/Qiskit/qiskit-ibm-provider/tree/stable/0.10/qiskit_ibm_provider/session.py#L109-L111" signature="cancel()">
Set the session.\_active status to False

**Return type**
Expand Down
Loading

0 comments on commit 07bf499

Please sign in to comment.