Skip to content

Commit

Permalink
Cross-references work
Browse files Browse the repository at this point in the history
  • Loading branch information
Eric-Arellano committed Mar 14, 2024
1 parent c2ee770 commit 612611d
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 5 deletions.
6 changes: 2 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,15 +98,13 @@ Now, create a new file in the `release-notes/unreleased` folder in the format `<
such as `156.bug.rst` or `231.feat.rst`.

Open up the new release note file and provide a description of the change, such as what users need
to do. The files use RST syntax and you can use mechanisms like code blocks. However, Sphinx
cross-references will not work and you should use full links to
https://docs.quantum.ibm.com when linking to documentation.
to do. The files use RST syntax and you can use mechanisms like code blocks and cross-references.

Example notes:

```rst
Add ``dd_barrier`` optional input to
```PadDynamicalDecoupling`` <https://docs.quantum.ibm.com/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling>`__
:class:`.PadDynamicalDecoupling`
constructor to identify portions of the circuit to apply dynamical
decoupling (dd) on selectively. If this string is contained in the
label of a barrier in the circuit, dd is applied on the delays ending
Expand Down
2 changes: 1 addition & 1 deletion release-notes/unreleased/1409.upgrade.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Modify ``skip_reset_qubits`` optional flag to the constructor for
```PadDynamicalDecoupling`` <https://docs.quantum.ibm.com/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling>`__. If ``False``, dynamical decoupling is applied on
:class:`.PadDynamicalDecoupling`. If ``False``, dynamical decoupling is applied on
qubits regardless of their state, even on delays that are at the beginning
of a circuit. This option now matches the behavior in Qiskit.

0 comments on commit 612611d

Please sign in to comment.