qiskit icon indicating copy to clipboard operation
qiskit copied to clipboard

Barrier API documentation is not informative

Open garrison opened this issue 3 years ago • 4 comments

What should we add?

A Google search for "qiskit barrier" leads one to its entry in the API reference as the first hit. Unfortunately, this page contains only a circular definition, and does not even explain what a barrier does:

Barrier instruction.

Create new barrier instruction.

There is a much more useful description by @chriseclectic on StackExchange, with tens of upvotes. I believe a similar explanation should be incorporated into the Barrier docstring(s).

garrison avatar May 17 '22 01:05 garrison

For reference, this is Chris's answer on stackexchange. The relevant docstrings that need updating are the QuantumCircuit.barrier method and the Barrier class.

jakelishman avatar May 23 '22 18:05 jakelishman

How is it going with this issue? I am interested to learn more and contributing.

faraimazh avatar May 28 '22 07:05 faraimazh

@faraimazh Do you want to work on this issue? I can assign you.

HuangJunye avatar May 30 '22 08:05 HuangJunye

Hi @HuangJunye , if it's okay, may I work on this?

san-gh avatar Sep 16 '22 09:09 san-gh

I'd like to work on this

DanielAja avatar Oct 26 '22 14:10 DanielAja

The PR #9015 is ready, please let me know if there is anything else needed from me

DanielAja avatar Dec 01 '22 16:12 DanielAja