Qiskit / qiskit
89%
main: 88%

LAST BUILD BRANCH: gucci
DEFAULT BRANCH: main
Repo Added
Files 870
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst

LAST BUILD ON BRANCH mergify/bp/stable/1.3/pr-13620
branch: mergify/bp/stable/1.3/pr-13620
CHANGE BRANCH
x

coverage: 88.913% (-0.02%) from 88.937%
13168405910

Pull #13795

github

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

* 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 4d2265f6... (continued)
Pull Request #13795: Increase documentation of built-in transpiler plugins (backport #13620)

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

24 existing lines in 3 files now uncovered.

79155 of 89025 relevant lines covered (88.91%)

357393.75 hits per line

Relevant lines Covered
89025 RELEVANT LINES 79155 COVERED LINES
357393.75 HITS PER LINE
Source Files on mergify/bp/stable/1.3/pr-13620

Recent builds

Builds Branch Commit Type Ran Committer Via Coverage
13168405910 mergify/bp/stable/1.3/pr-13620 Increase documentation of built-in transpiler plugins (#13620) * 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 ... Pull #13795 jakelishman github
88.91
13165124009 mergify/bp/stable/1.3/pr-13620 Increase documentation of built-in transpiler plugins (#13620) * 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 ... Pull #13795 mergify[bot] github
88.92
See All Builds (13828)