19082004987
88%

Ran 04 Nov 2025 09:12PM UTC

Jobs 1

Files 873

Run time 3min

Badge

Embed ▾

Committed 04 Nov 2025 08:08PM UTC coverage: 88.199% (+0.005%) from 88.194%

Build # 19082004987

Build Type

push

github

Committed by

web-flow

Commit Message

Add descriptions of primitives container objects (#15292)

* Add descriptions of primitives container objects

This adds prose descriptions of the "container" and "handle" objects of
`qiskit.primitives`, which previously had stub documentation.  When
users are using the primitives and the returned objects interactively,
it can be very difficult to tell how to use each individual object,
especially because several of them are implemented using "magic
methods", which do not get suggested by code completion, and were not
alluded to in the per-class API documentation.

This PR doesn't include per-object examples - I didn't feel entirely
comfortable trying to fill that in myself - but the prose should
hopefully already be a significant improvement.

* Fix run-on inline code

* Correct source of `PrimitiveResult`

* Add discussion of `BitArray` constructors

Co-authored-by: Ian Hincks <2229105+ihincks@users.noreply.github.com>

---------

Co-authored-by: Ian Hincks <2229105+ihincks@users.noreply.github.com>

Run Details

93875 of 106435 relevant lines covered (88.2%)

1159825.43 hits per line

Uncovered Existing Lines

Lines	Coverage	∆	File
3	92.8	0.26%	crates/qasm2/src/lex.rs
7	72.86	-0.29%	crates/circuit/src/parameter/symbol_expr.rs

Jobs

ID	Job ID	Ran	Files	Coverage
1	19082004987.1	04 Nov 2025 09:12PM UTC	873	88.2	GitHub Action Run

Qiskit / qiskit / 19082004987
88%

README BADGES
x

Markdown

Textile

RDoc

HTML

Rst

Uncovered Existing Lines

Jobs

Source Files on build 19082004987

Qiskit / qiskit / 19082004987 88%

README BADGES x

Markdown

Textile

RDoc

HTML

Rst

Uncovered Existing Lines

Jobs

Source Files on build 19082004987

Qiskit / qiskit / 19082004987
88%

README BADGES
x