Qiskit / Qiskit/documentation

Dense paragraph about Premium Plan instances

Open Beginner friendly
#5,142 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/instances#premium-plan-instance

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

The second sentence is particularly dense due to all the parentheticals:

An administrator can set a usage limit on a Premium Plan instance that applies for the plan's 28-day rolling usage window. If an instance has been marked as "limited" by your administrator (you will see a "Remaining" column in the usage area) and the instance exceeds its allocation (defined by your administrator), any active workload will continue running (including sessions) but pending workloads will remain in the queue until more time is available. If an instance is not limited and the instance exceeds its allocation, jobs run with that instance are likely to run at a lower priority and experience longer queue times.

This makes it hard to read, and probably results in a bad translation. Can the sentence be split up?

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

(No answer)

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

Open the Premium Plan instance section at the linked guide and review the quoted paragraph in context. Split the dense sentence into clearer sentences while preserving the usage-limit, workload, and queueing behavior described. Done means the passage is easier to read and translate without changing its meaning.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
85/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.