-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Improve docstring for unitary() & other text in unitary_protocol.py #7582
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
Improve docstring for unitary() & other text in unitary_protocol.py #7582
Conversation
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.
|
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 1090 1090
Lines 98248 98248
=======================================
Hits 97643 97643
Misses 605 605 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
pavoljuhas
left a comment
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.
Let us sync this with the current state of the code after #7595 - please see inline comments.
Otherwise LGTM.
|
@mhucka - can you PTAL at your convenience? |
Co-authored-by: Pavol Juhas <pavol.juhas@gmail.com>
Co-authored-by: Pavol Juhas <pavol.juhas@gmail.com>
mhucka
left a comment
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.
Thanks for the feedback and corrections!
pavoljuhas
left a comment
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.
Thank you!
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.