Qiskit / qiskit / 9113940979

88%

Build Type

push

github

Committed by web-flow

Commit Message

Write complete manual `QuantumCircuit` documentation (#12403)

* Write complete manual `QuantumCircuit` documentation

This writes huge tracts of new `QuantumCircuit` API documentation,
linking together alike methods and writing explanatory text for how all
the components fit together.  There's likely an awful lot more that
could go into this too, but this hopefully should impose a lot more
order on the huge `QuantumCircuit` documentation page, and provide a lot
more explanation for how the class works holistically.

In particular, the section on the control-flow builder interface could
do with a lot more exposition and examples right now.

* Reword from review

Co-authored-by: Matthew Treinish <mtreinish@kortar.org>

* Add missing text around `Var` methods

* Add example to `find_bit`

* Comment on metadata through serialization

* Add see-also sections to undesirable methods

* Re-add internal utilities to documentation

* Add examples to `depth`

---------

Co-authored-by: Matthew Treinish <mtreinish@kortar.org>

Run Details

7 of 7 new or added lines in 1 file covered. (100.0%)

8 existing lines in 2 files now uncovered.

62292 of 69522 relevant lines covered (89.6%)

228808.3 hits per line