From 5ae4790cf6f7ca918b2d1cb9a740bd4287171c30 Mon Sep 17 00:00:00 2001 From: Luciano Bello Date: Mon, 19 Feb 2024 15:52:02 +0100 Subject: [PATCH] quantum-computing.ibm.com is going to disappear, eventually (#11830) * quantum-computing.ibm.com is going to disappear, eventually * black * Add changes in `MAINTAING.md` * Fix broken links --------- Co-authored-by: Jake Lishman Co-authored-by: Jake Lishman --- MAINTAINING.md | 6 +++--- qiskit/circuit/quantumcircuit.py | 2 +- qiskit/qpy/__init__.py | 2 +- qiskit/transpiler/passes/basis/basis_translator.py | 6 +++--- .../passes/scheduling/alignments/pulse_gate_validation.py | 2 +- 5 files changed, 9 insertions(+), 9 deletions(-) diff --git a/MAINTAINING.md b/MAINTAINING.md index bf51e67fe79d..e20cab09a128 100644 --- a/MAINTAINING.md +++ b/MAINTAINING.md @@ -43,11 +43,11 @@ The way documentation is structured in Qiskit is to push as much of the actual documentation into the docstrings as possible. This makes it easier for additions and corrections to be made during development, because the majority of the documentation lives near the code being changed. These docstrings are then pulled into -the API Reference section of https://docs.quantum-computing.ibm.com. +the API Reference section of https://docs.quantum.ibm.com. Refer to https://qiskit.github.io/qiskit_sphinx_theme/apidocs/index.html for how to create and write effective API documentation, such as setting up the RST files and docstrings. -If changes you are making affect non-API reference content in https://docs.quantum-computing.ibm.com +If changes you are making affect non-API reference content in https://docs.quantum.ibm.com you can open an issue (or better yet a PR) to update the relevant page in https://github.com/Qiskit/documentation. -You can also use this repo to suggest or contribute brand new content beyond updates to the API reference. \ No newline at end of file +You can also use this repo to suggest or contribute brand new content beyond updates to the API reference. diff --git a/qiskit/circuit/quantumcircuit.py b/qiskit/circuit/quantumcircuit.py index 894d6355c3f2..018d0560fc9e 100644 --- a/qiskit/circuit/quantumcircuit.py +++ b/qiskit/circuit/quantumcircuit.py @@ -1025,7 +1025,7 @@ def tensor(self, other: "QuantumCircuit", inplace: bool = False) -> Optional["Qu Remember that in the little-endian convention the leftmost operation will be at the bottom of the circuit. See also - `the docs `__ + `the docs `__ for more information. .. parsed-literal:: diff --git a/qiskit/qpy/__init__.py b/qiskit/qpy/__init__.py index f47961ffb496..c04ca409d093 100644 --- a/qiskit/qpy/__init__.py +++ b/qiskit/qpy/__init__.py @@ -540,7 +540,7 @@ With the support of :class:`.~ScheduleBlock`, now :class:`~.QuantumCircuit` can be serialized together with :attr:`~.QuantumCircuit.calibrations`, or -`Pulse Gates `_. +`Pulse Gates `_. In QPY version 5 and above, :ref:`qpy_circuit_calibrations` payload is packed after the :ref:`qpy_instructions` block. diff --git a/qiskit/transpiler/passes/basis/basis_translator.py b/qiskit/transpiler/passes/basis/basis_translator.py index f004fb2e58f0..c38d65817769 100644 --- a/qiskit/transpiler/passes/basis/basis_translator.py +++ b/qiskit/transpiler/passes/basis/basis_translator.py @@ -109,7 +109,7 @@ def __init__(self, equivalence_library, target_basis, target=None, min_qubits=0) equivalence_library (EquivalenceLibrary): The equivalence library which will be used by the BasisTranslator pass. (Instructions in this library will not be unrolled by this pass.) - target_basis (list[str]): Target basis names to unroll to, e.g. `['u3', 'cx']`. + target_basis (list[str]): Target basis names to unroll to, e.g. ``['u3', 'cx']``. target (Target): The backend compilation target min_qubits (int): The minimum number of qubits for operations in the input dag to translate. @@ -207,7 +207,7 @@ def run(self, dag): "target basis is not universal or there are additional equivalence rules " "needed in the EquivalenceLibrary being used. For more details on this " "error see: " - "https://docs.quantum-computing.ibm.com/api/qiskit/qiskit.transpiler.passes." + "https://docs.quantum.ibm.com/api/qiskit/transpiler_passes." "BasisTranslator#translation-errors" ) @@ -225,7 +225,7 @@ def run(self, dag): f"basis: {list(target_basis)}. This likely means the target basis is not universal " "or there are additional equivalence rules needed in the EquivalenceLibrary being " "used. For more details on this error see: " - "https://docs.quantum-computing.ibm.com/api/qiskit/qiskit.transpiler.passes." + "https://docs.quantum.ibm.com/api/qiskit/transpiler_passes." "BasisTranslator#translation-errors" ) diff --git a/qiskit/transpiler/passes/scheduling/alignments/pulse_gate_validation.py b/qiskit/transpiler/passes/scheduling/alignments/pulse_gate_validation.py index e4bcdecbb666..4bf55913450e 100644 --- a/qiskit/transpiler/passes/scheduling/alignments/pulse_gate_validation.py +++ b/qiskit/transpiler/passes/scheduling/alignments/pulse_gate_validation.py @@ -30,7 +30,7 @@ class ValidatePulseGates(AnalysisPass): In Qiskit SDK, we can define the pulse-level implementation of custom quantum gate instructions, as a `pulse gate - `__, + `__, thus user gates should satisfy all waveform memory constraints imposed by the backend. This pass validates all attached calibration entries and raises ``TranspilerError`` to