qiskit-metapackage icon indicating copy to clipboard operation
qiskit-metapackage copied to clipboard

IBM Quantum Provider API Reference TOC doesn't match with the code

Open y4izus opened this issue 3 years ago • 1 comments

Informations

It's a documentation related issue so no need of Qiskit or Python versions nor Operating System

What is the current behavior?

The TOC on the documentation page for IBM Quantum Provider API Reference doesn't match the code

  1. Links on the page:
  • ibmq_provider ✔
  • ibmq_job ✔
  • ibmq_managed ✔
  • ibmq_credentials ✔
  • ibmq_utils ✔
  • ibmq_random ❌
  • ibmq_experiment ✔
  • ibmq_runtime
  1. Links on the code:
  • ibmq_provider ✔
  • ibmq_job ✔
  • ibmq_managed ✔
  • ibmq_credentials ✔
  • ibmq_visualization ❌
  • ibmq_jupyter ❌
  • ibmq_utils ✔
  • ibmq_experiment
  • ibmq_runtime ✔

Steps to reproduce the problem

Go to the links above and compare

What is the expected behavior?

Contents should match

Suggested solutions

I thought that after this commit we didn't deploy the docs, but I have checked and we did, so I have no idea why the info is not matching

Notes

This issue is related with this one, but I've opened it because, as far as I know, we stopped using Travis in favor of GitHub actions and also there is a new line that doesn't match

y4izus avatar Feb 02 '22 09:02 y4izus

The first point is because the metapackage pulls from its requirements, so it won't update until IBM Q provider puts out a new patch release, and we include it in the metapackage. We can arrange to do that soon - Terra is going to do a patch release today or tomorrow as well.

jakelishman avatar Feb 02 '22 12:02 jakelishman