Skip to content
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

Merged
merged 2 commits into from
May 8, 2024

Conversation

jordandsullivan
Copy link
Contributor

@jordandsullivan jordandsullivan commented May 8, 2024

Updated docstring for generate_mirror_circuits to reflect accurate return types

Description


License

  • I license this contribution under the terms of the GNU GPL, version 3 and grant Unitary Fund the right to provide additional permissions as described in section 7 of the GNU GPL, version 3.

Before opening the PR, please ensure you have completed the following where appropriate.

@jordandsullivan jordandsullivan linked an issue May 8, 2024 that may be closed by this pull request
Copy link

codecov bot commented May 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.22%. Comparing base (8b9ba75) to head (69efc6b).
Report is 1 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

@@ -149,7 +149,7 @@ def generate_mirror_circuit(
``cirq.Circuit``.

Returns:
A randomized mirror circuit.
A randomized mirror circuit and correct bitstring.
Copy link
Contributor

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?

@jordandsullivan jordandsullivan mentioned this pull request May 8, 2024
6 tasks
@cosenal cosenal self-requested a review May 8, 2024 18:32
@jordandsullivan jordandsullivan merged commit 2ff8134 into main May 8, 2024
17 of 18 checks passed
@jordandsullivan jordandsullivan deleted the 2316-mirror-circuit-docstring-incorrect branch May 8, 2024 18:33
cosenal pushed a commit that referenced this pull request Jun 26, 2024
* Updated docstring for generate_mirror_circuits to reflect accurate return types

* Clarify meaning of `correct bitstring`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Mirror circuit docstring incorrect
2 participants