Improve docstring for unitary() & other text in unitary_protocol.py #7582
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
The behavior of the function `unitary()` changed with respect to NumPy array arguments. I found the docstring not clear enough during some recent debugging on another issue. I rewrote that part, then noticed inconsistencies in formatting and language elsewhehre, so ended up editing other parts of this file too.
Collaborator
| Let us first converge on #7595 and then adjust the text here accordingly. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@ ## main #7582 +/- ## ======================================= Coverage 99.38% 99.38% ======================================= Files 1091 1091 Lines 97815 97815 ======================================= Hits 97214 97214 Misses 601 601 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
pavoljuhas requested changes Oct 31, 2025
Collaborator
pavoljuhas left a comment
pavoljuhas left a comment There was a problem hiding this comment.
Let us sync this with the current state of the code after #7595 - please see inline comments.
Otherwise LGTM.
Comment on lines +86 to +88
| - If the value is a NumPy array, it is tested using `linalg.is_unitary()`. | ||
| If the result is `True`, the array is returned directly; if `is_unitary()` | ||
| returns `False`, a `ValueError` exception is raised. |
Collaborator
There was a problem hiding this comment.
Suggested change
| - If the value is a NumPy array, it is tested using `linalg.is_unitary()`. | |
| If the result is `True`, the array is returned directly; if `is_unitary()` | |
| returns `False`, a `ValueError` exception is raised. | |
| - If the value is a NumPy array, it is returned directly. |
| "\n" | ||
| "The value failed to satisfy any of the following criteria:\n" | ||
| "The given value failed to satisfy any of the following criteria:\n" | ||
| "- A NumPy array for which `linalg.is_unitary()` returned `True`.\n" |
Collaborator
There was a problem hiding this comment.
This is not checked anymore and thus not possible here.
Suggested change
| "- A NumPy array for which `linalg.is_unitary()` returned `True`.\n" |
Collaborator
| @mhucka - can you PTAL at your convenience? |
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
The behavior of the function
unitary(…)changed with respect to NumPy array arguments. I found the docstring not clear enough during some recent debugging on another issue. I rewrote that part, then noticed inconsistencies in formatting and language elsewhehre, so ended up editing other parts of this file too.