Skip to content

Commit

Permalink
fix documentation of circuit depth filter function (#9320)
Browse files Browse the repository at this point in the history
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
  • Loading branch information
kevinsung and mergify[bot] authored Jan 9, 2023
1 parent f0f8638 commit 95b98d4
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion qiskit/circuit/quantumcircuit.py
Original file line number Diff line number Diff line change
Expand Up @@ -1925,8 +1925,10 @@ def depth(
"""Return circuit depth (i.e., length of critical path).
Args:
filter_function (callable): a function to filter out some instructions.
filter_function (callable): A function to filter instructions.
Should take as input a tuple of (Instruction, list(Qubit), list(Clbit)).
Instructions for which the function returns False are ignored in the
computation of the circuit depth.
By default filters out "directives", such as barrier or snapshot.
Returns:
Expand Down

0 comments on commit 95b98d4

Please sign in to comment.