Skip to content

DOC-558: add ic.stop() in the code field in Compiling To Hardware!

Explanation of changes

Added ic.stop() in the code field to drive adoption of this as a must, but not optional line.

Motivation of changes

When running two consecutive measurements, if the required sequencer(s) of the EXP2 form a subset of sequencer(s) of EXP1, the absence of ic.stop() will cause the timeout error. () This was reported by a customer and we cannot remotely troubleshoot this problem. During the on-site visit, it also takes us quite a few hours to figure this out. More details see JIRA ticket in DOC-558.


Merge checklist

See also merge request guidelines

  • Merge request has been reviewed (in-depth by a knowledgeable contributor), and is approved by a project maintainer.
  • New code is covered by unit tests (or N/A).
  • New code is documented and docstrings use numpydoc format (or N/A).
  • New functionality: considered making private instead of extending public API (or N/A).
  • Public API changed: added @deprecated and entry in deprecated code suggestions (or N/A).
  • Newly added/adjusted documentation and docstrings render properly (or N/A).
  • Pipeline fix or dependency update: post in #software-for-developers channel to merge main back in or update local packages (or N/A).
  • Tested on hardware (or N/A).
  • CHANGELOG.md for breaking changes and AUTHORS.md have been updated (or N/A).
  • Update Hardware backends documentation if backend interface change or N/A
  • Check whether performance is significantly affected by looking at the Performance metrics results.
  • Windows tests in CI pipeline pass (manually triggered by maintainers before merging).
    • Maintainers do not hit Auto-merge, we need to actively check as manual tests do not block pipeline

For reference, the issues workflow is described in the contribution guidelines.

Merge request reports

Loading