Qiskit / qiskit-ibm-runtime / 12013683683
83%

DEFAULT BRANCH: main
Ran
Jobs 13
Files 236
Run time 2min
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: 80.105%. Remained the same
12013683683

push

github

web-flow 
Fix type hints in docs for PUBs and improve Sphinx config (#2052)

Closes https://github.com/Qiskit/qiskit-ibm-runtime/issues/1877. We now use `EstimatorPubLike` and `SamplerPubLike` for the type hints, rather than Sphinx fully expanding the types into extremely long values shown in #1877.

To fix the type hints, we have to stop using `sphinx-autodoc-typehints` and instead use autodoc's builtin support for type hints. I didn't realize we were still using `sphinx-autodoc-typehints` - the other Qiskit projects migrated off a while ago.

This PR also makes some other improvements to align with changes we made in Qiskit Addons & qiskit-ibm-transpiler:

* always show inheritance in class pages for the base class
* index page should show the PyPI package name in code syntax
* don't show signatures in `autosummary` tables, since they're noisy
* show type hints for parameters that don't have docstring

## Introduces a regression: type hints for properties

Unfortunately, switching off of `sphinx-autodoc-typehints` results in https://github.com/Qiskit/documentation/issues/2346. This is a quirk of autosummary that we cannot easily fix. We have a plan to fix it, although realistically won't get to it until Q1 and possibly Q2.

In the meantime, consider repeating some of the type information in the docstring. For example, in

```
<Attribute id="qiskit_ibm_runtime.EstimatorV2.mode">
    Return the execution mode used by this primitive.
```

You could rewrite to say

```
<Attribute id="qiskit_ibm_runtime.EstimatorV2.mode">
    Return the execution mode used by this primitive, either :class:~`.Session` or ~:class:~`.Batch`.
```

6579 of 8213 relevant lines covered (80.1%)

9.71 hits per line

Jobs
ID Job ID Ran Files Coverage
1 unit-tests_python3.10-ubuntu-latest - 12013683683.1 234
78.95
 GitHub Action Run
2 unit-tests_python3.9-windows-latest - 12013683683.2 234
77.01
 GitHub Action Run
3 unit-tests_python3.12-windows-latest - 12013683683.3 234
77.16
 GitHub Action Run
4 unit-tests_python3.9-ubuntu-latest - 12013683683.4 234
78.81
 GitHub Action Run
5 unit-tests_python3.11-macos-latest - 12013683683.5 234
78.95
 GitHub Action Run
6 unit-tests_python3.10-windows-latest - 12013683683.6 234
77.11
 GitHub Action Run
7 unit-tests_python3.12-ubuntu-latest - 12013683683.7 234
78.95
 GitHub Action Run
8 unit-tests_python3.11-windows-latest - 12013683683.8 234
77.16
 GitHub Action Run
9 unit-tests_python3.11-ubuntu-latest - 12013683683.9 234
78.95
 GitHub Action Run
10 unit-tests_python3.12-macos-latest - 12013683683.10 234
78.95
 GitHub Action Run
11 unit-tests_python3.8-ubuntu-latest - 12013683683.11 236
79.94
 GitHub Action Run
12 unit-tests_python3.10-macos-latest - 12013683683.12 234
78.95
 GitHub Action Run
13 unit-tests_python3.8-windows-latest - 12013683683.13 236
78.23
 GitHub Action Run
Source Files on build 12013683683