search

unitaryfund / mitiq

Mitiq is an open source toolkit for implementing error mitigation techniques on most current intermediate-scale quantum computers.
https://mitiq.readthedocs.io
GNU General Public License v3.0
363 stars 163 forks source link

Mirror circuit docstring incorrect #2316

Closed natestemen closed 6 months ago

natestemen commented 6 months ago

Issue

The generate_mirror_circuit utility function returns both a circuit, and a correct bitstring. https://github.com/unitaryfund/mitiq/blob/fe3a6669c3fe2d7197ab02fa37765653392ee97e/mitiq/benchmarks/mirror_circuits.py#L128-L135

The API-doc, however, only shows that this function returns a circuit.

Solution

The docstring needs to be updated to ensure the code and docs are in alignment.