Qiskit / coheriq / 41485539770
92%
main: 93%

LAST BUILD BRANCH: gh-readonly-queue/main/pr-52-97a9f9f411b6aec7d08423c39d92b179d3d568b5
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: 91.525%. Remained the same
41485539770

push

github

web-flow 
Improve the README, user guide, and platform test coverage (#50)

* Improve the README, user guide, and platform test coverage

The note at the top of the user guide told the reader to call
enable_engine before explaining what a domain is or how to find out
which engines exist.  Replace it with a four-step path that a newcomer
can follow start to finish: import the library and confirm it declares a
domain with known_domains, list the engines with available_engines,
install one, then activate it.  known_domains and active_engine were
previously absent from the guide entirely.

The guide also used two different names for the same example engine.
Settle on fast-engine, and say explicitly that the name you enable is
not the distribution name you installed, since the example installs
mylib-fast-engine.

Expand the latest-version test matrix to cover both x86_64 and ARM on
all three operating systems, which is what the README's platform section
now claims.  macos-latest is already ARM, so this adds Linux ARM,
Windows ARM, and macos-15-intel for the x86_64 macOS slot.  Coheriq
itself is pure Python, but the example engine the notebook and
ragged-engine envs build is compiled, so the architecture matters for
those.

Give both the README and the conceptual overview a paragraph on where
Coheriq came from, and say when the multiple-of-ten versioning rule
stops applying.  Also stop asserting that an acceleration engine is
always a separate package: an engine is ordinary Python and can be
defined anywhere, as the diamond inheritance demo does in a notebook.

Finally, have the README's engine example pass the module rather than
the domain name, matching the documentation home page.

Assisted-by: Claude Opus 5

* Update sphinx author and copyright

* Apply suggestion from @garrison

270 of 295 relevant lines covered (91.53%)

0.92 hits per line

Jobs
ID Job ID Ran Files Coverage
1 41485539770.1 5
91.53
GitHub Action Run
Source Files on build 41485539770