question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Barrier API documentation is not informative

See original GitHub issue

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).

Issue Analytics

  • State:closed
  • Created a year ago
  • Comments:6 (5 by maintainers)

github_iconTop GitHub Comments

2reactions
jakelishmancommented, May 23, 2022

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

1reaction
HuangJunyecommented, May 30, 2022

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

Read more comments on GitHub >

github_iconTop Results From Across the Web

How to Write Good API Documentation - freeCodeCamp
So a good alternative is to assign the task of API documentation to a technical writer. A technical writer is someone who combines...
Read more >
Overview (Java Platform SE 8 ) - Oracle Help Center
Provides the API for accessing and processing data stored in a data source (usually a relational database) using the Java TM programming language....
Read more >
Automatic API Documentation in Node.js Using Swagger
There are other possibilities, such as: ignoring a given endpoint using the tag “#swagger.ignore = true”, making the endpoint not appear in the ......
Read more >
Direct request—ArcGIS REST APIs
This property is not required if the coordinates are in the default spatial reference, WGS84. If the coordinates are in a different spatial...
Read more >
Message | Android Developers
Each Handler has its own name-space for message codes, so you do not need to worry about ... Asynchronous messages are exempt from...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found