Qiskit / qiskit / 13169806185

89%

main: 88%

Build Type

push

github

Committed by web-flow

Commit Message

Increase documentation of built-in transpiler plugins (#13620) (#13795)

* Increase documentation of built-in transpiler plugins

This overhauls how the `qiskit.transpiler` documentation talks about the
transpiler plugins.  All of the built-in plugins now have a decent
amount of overview documentation, and the requirements and expectations
for each stage of the preset pipelines is explained in more detail.

This form of the documentation makes the distinction between "a
compilation routine in general" and "Qiskit's specific choice of default
pipeline" clearer, to avoid confusion for advanced users.

Much of the guide-level explanations of the different preset pipeline
stages moved to https://docs.quantum.ibm.com some time ago, so this PR
removes those, in favour of focussing on the actual API, and inserts
links to learn more about the principles elsewhere.

The guide-level explanation of scheduling is left in-place for now,
because the content on the other parts of the IBM documentation isn't as
complete for that.

* Fix cross references in release notes

* Include Elena's suggestions

Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com>

* Apply copy-editing suggestions

Co-authored-by: abbycross <across@us.ibm.com>

* Add manual copy-editing suggestions

* Reflow text

* Copy edit

Co-authored-by: Rebecca Dimock <66339736+beckykd@users.noreply.github.com>

* Add missed copy edit

Co-authored-by: Rebecca Dimock <66339736+beckykd@users.noreply.github.com>

* Reflow line breaks

* Apply Elena's suggestions

Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com>

* Apply Elena's suggestions that needed line wraps

* Correct layout description

* Mark stochastic plugin as deprecated

---------

Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com>
Co-authored-by: abbycross <across@us.ibm.com>
Co-authored-by: Rebecca Dimock <66339736+beckykd@users.noreply.github.com>
(cherry picked from commit... (continued)

Run Details

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

9 existing lines in 3 files now uncovered.

79161 of 89025 relevant lines covered (88.92%)

358221.83 hits per line