-
-
Notifications
You must be signed in to change notification settings - Fork 158
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Updated docstring for generate_mirror_circuits
#2353
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2353 +/- ##
=======================================
Coverage 98.22% 98.22%
=======================================
Files 87 87
Lines 4056 4059 +3
=======================================
+ Hits 3984 3987 +3
Misses 72 72 ☔ View full report in Codecov by Sentry. |
mitiq/benchmarks/mirror_circuits.py
Outdated
@@ -149,7 +149,7 @@ def generate_mirror_circuit( | |||
``cirq.Circuit``. | |||
|
|||
Returns: | |||
A randomized mirror circuit. | |||
A randomized mirror circuit and correct bitstring. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We can say A tuple of a randomized mirror circuit of type return_type, and the correct bitstring
.
I left a comment in #2344: what's the meaning of correct here?
* Updated docstring for generate_mirror_circuits to reflect accurate return types * Clarify meaning of `correct bitstring`
Updated docstring for generate_mirror_circuits to reflect accurate return types
Description
License
Before opening the PR, please ensure you have completed the following where appropriate.