search

Qiskit / qiskit

Qiskit is an open-source SDK for working with quantum computers at the level of extended quantum circuits, operators, and primitives.
https://www.ibm.com/quantum/qiskit
Apache License 2.0
5.24k stars 2.36k forks source link

Document `get_standard_gate_name_mapping` #13108

Closed wshanks closed 4 days ago

wshanks commented 2 months ago

get_standard_gate_name_mapping is referenced in the Target documentation now and used in several other projects (GitHub search brings up qiskit-experiments, qiskit-aer, blackwater, and qiskit-ibm-runtime among others). It would be nice to document it so it is officially part of the public API.

Shivansh20128 commented 1 month ago

@1ucian0 Hi! I am new to Qiskit open source, and want to work on this issue. Can you please assign it to me? Thanks

1ucian0 commented 1 month ago

Welcome!

Shivansh20128 commented 1 month ago

Hi, @1ucian0! I have prepared the material for the function _get_standard_gate_namemapping(), but I am unsure where to write it. Shall I write it under the Standard Gates section here, as the function is a part of _qiskit.circuit.library.standardgates as you can see here.

Apologies if this is an inappropriate question. Thank You

1ucian0 commented 1 month ago

I think the original issue is to document the function itself. It can definitely link to Standard gate section.

Shivansh20128 commented 1 month ago

Pull request has been created link. I hope it is fine. Thank You

Shivansh20128 commented 1 month ago

I have created a new PR—I apologize for the inconvenience. Thank You