Document missing passes in qiskit.transpiler.passes

[jakelishman]

Over time, a few passes have been added in this module that weren't added to the documentation at the same time. This corrects the oversight.

Apologies for the sorting of the imports - it made it rather easier to tell where there were discrepancies between the imports and the docs.

Summary

Details and comments

The primary purpose of this was to add LayoutTransformation, since @wshanks pointed out to me that it was missing. I believe that the other passes added are:

• LayoutTransformation
• OptimizeCliffordT
• OptimizeSwapBeforeMeasure
• ResourceEstimation
• HLSConfig

Things (that I noticed) that are imported into qiskit.transpiler.passes but are not added to the docs here, because they're documented elsewhere:

• AQCSynthesisPlugin
• CliffordUnitarySynthesis
• SolovayKitaevSynthesis

[qiskit-bot]

One or more of the following people are relevant to this code:

• @Qiskit/terra-core

[coveralls]

Pull Request Test Coverage Report for Build 16447991586

Details

• 41 of 41 (100.0%) changed or added relevant lines in 1 file are covered.
• 30 unchanged lines in 3 files lost coverage.
• Overall coverage decreased (-0.03%) to 87.754%

---

Files with Coverage Reduction	New Missed Lines	%
crates/circuit/src/symbol_expr.rs	6	73.73%
crates/qasm2/src/lex.rs	6	91.75%
crates/qasm2/src/parse.rs	18	96.62%

Totals
Change from base Build 16420779601:	-0.03%
Covered Lines:	81464
Relevant Lines:	92832

---

💛 - Coveralls

[wshanks]

Thanks, @jakelishman! You opened the PR faster than I could get to opening an issue to ask for it 🙂

You might want to review the docstring for LayoutTransformation. It is pretty terse and I am not sure if "for more details see the code" is a good thing to keep in the public documentation.

[jakelishman]

Oh boy haha - I hadn't looked at any of the documentation bits that were newly getting pulled in, just trying to make sure that the public interface is correctly set.

Fwiw, I think there are a lot of transpiler passes that could do with having their documentation reviewed, so I'd probably like to leave that for a follow up.