Qiskit / Qiskit/documentation

Add precision on values a user see

Open
#4,051 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

content 📄
Dominant language
Jupyter Notebook
Stars
106
Forks
223
Avg merge
1d 8h
Merged PRs (30d)
72

Description

URL to the relevant guide or resource

https://quantum.cloud.ibm.com/docs/en/guides/estimate-job-run-time#view-instance-usage

Select all that apply
  • new content request
  • typo
  • code bug
  • out-of-date content
  • broken link
  • other
Describe the fix or the content request.

We should increase the level of documentation for each value the user sees when looking at instance details.
Like Instance / Cycle usage / Time remaining / Time allocated and Current cycle (UTC).
The word "Rolling" could be linked to https://quantum.cloud.ibm.com/docs/en/guides/fair-share-scheduler#fair-share-terms

For new content requests - if the request is accepted, do you want to write the content?

I only want to review the material when it's finished

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the “View instance usage” section of the linked estimate job run time guide. Review how Instance, Cycle usage, Time remaining, Time allocated, and Current cycle (UTC) are described, and check the fair-share terms guide for the “Rolling” link. Done means each listed value has clearer documentation and the requested link is included.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.