Skip to content

Commit

Permalink
Rework explanation of execution option overrides
Browse files Browse the repository at this point in the history
  • Loading branch information
buehlefs committed Aug 16, 2023
1 parent d3ad964 commit dc75ccc
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions docs/plugin-types/circuit-executor.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,9 +69,11 @@ Circuit executor plugins can have two types of data (i.e. file based) inputs:

Circuit executor plugins can have two types of direct parameter inputs:

* **Execution optiones**: circuit executor plugins can expose some of the execution options as parameters.
* **Execution option overrides**: circuit executor plugins can expose some of the execution options (usually received through the `executionOptions` parameter) as additional parameters.
These parameters **must** all be **optional** inputs.
If they are set, they override the values from the execution options.
If they are set, they override the values from the file based execution options.

For example, the number of shots can be exposed as an additional parameter so that users can directly set this option from the plugin ui without first constructing the execution options data.
* **Authentication details**: this can include username+password or API tokens.
The authentication parameters **must** be **optional**.

Expand Down

0 comments on commit dc75ccc

Please sign in to comment.