Qiskit / coheriq / 41114312275
93%

DEFAULT BRANCH: main
Ran
Jobs 1
Files 5
Run time 1min
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
coverage: 90.119%. Remained the same
41114312275

push

github

web-flow 
Document the reference implementation as an engine (#26)

* Document the reference implementation as an engine

Follows the API change that makes a domain's own implementations addressable as
an engine named "reference".  The vocabulary needed less revision than expected:
the overview already defines an engine by *what is substituted* -- a coherent
unit of behavior, state, and invariants, chosen as a whole -- rather than by who
wrote it or how fast it is, and the reference implementation fits that
definition unchanged.  So this mostly makes an existing idea explicit.

Two new FAQ entries:

- "Is the reference implementation an engine?" gives the structural argument
  (materialize() builds the class every engine inherits from, and dispatch does
  not branch on the two cases), and says why "reference" rather than "default":
  default describes only what happens when nobody chooses, while reference
  describes what the implementation is, which stays true when it is selected
  deliberately.
- "Why can the reference implementation be enabled explicitly?" explains the
  case that silence cannot cover, since an environment variable overrides a
  default but must not override an explicit choice.

The one-way activation contract needed the most care, in both the overview and
the FAQ.  "Enable the reference implementation" can read as a disable or a
reset, which the contract forbids.  It is neither: it is a transition forward
into a settled state that rules out the other engines, in exactly the way
enabling any engine rules out the rest.  Both places now say so, and the
contract is phrased in terms of transitions rather than of which engine is
chosen.

The overview's three-party model says the parties are roles rather than
necessarily three packages, since the domain now fills the engine role for its
own reference implementation.

The user guide's "Query the available engines" section promised a mechanism in
the future; available_engines() exists, so it documen... (continued)

228 of 253 relevant lines covered (90.12%)

0.9 hits per line

Jobs
ID Job ID Ran Files Coverage
1 41114312275.1 5
90.12
GitHub Action Run
Source Files on build 41114312275