Skip to content

Commit

Permalink
Update the docsring of the circuit library (#9668) (#9671)
Browse files Browse the repository at this point in the history
* add gates to docstring in circuit/library/__init__.py

* remove unused docstring in standard_gates/__init__.py

* remove MCPhaseGate from standard gates, as it already appears in generalized gates

(cherry picked from commit 19a293e)

Co-authored-by: Shelly Garion <46566946+ShellyGarion@users.noreply.github.com>
  • Loading branch information
mergify[bot] and ShellyGarion authored Feb 27, 2023
1 parent 215aa22 commit f780ca8
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 62 deletions.
7 changes: 5 additions & 2 deletions qiskit/circuit/library/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,8 @@
CRXGate
CRYGate
CRZGate
CSGate
CSdgGate
CSwapGate
CSXGate
CUGate
Expand All @@ -89,6 +91,8 @@
CXGate
CYGate
CZGate
CCZGate
ECRGate
HGate
IGate
MSGate
Expand All @@ -103,9 +107,8 @@
RZGate
RZZGate
RZXGate
XXPlusYYGate
XXMinusYYGate
ECRGate
XXPlusYYGate
SGate
SdgGate
SwapGate
Expand Down
61 changes: 1 addition & 60 deletions qiskit/circuit/library/standard_gates/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,66 +11,7 @@
# that they have been altered from the originals.

"""
=============================================================
Standard gates (:mod:`qiskit.circuit.library.standard_gates`)
=============================================================
.. autosummary::
:toctree: ../stubs/
C3XGate
C3SXGate
C4XGate
CCXGate
DCXGate
CHGate
CPhaseGate
CRXGate
CRYGate
CRZGate
CSwapGate
CSXGate
CUGate
CU1Gate
CU3Gate
CXGate
CYGate
CZGate
CCZGate
HGate
IGate
MCPhaseGate
PhaseGate
RCCXGate
RC3XGate
RXGate
RXXGate
RYGate
RYYGate
RZGate
RZZGate
RZXGate
XXMinusYYGate
XXPlusYYGate
ECRGate
SGate
SdgGate
CSGate
CSdgGate
SwapGate
iSwapGate
SXGate
SXdgGate
TGate
TdgGate
UGate
U1Gate
U2Gate
U3Gate
XGate
YGate
ZGate
Standard gates
"""

from .h import HGate, CHGate
Expand Down

0 comments on commit f780ca8

Please sign in to comment.