-
Notifications
You must be signed in to change notification settings - Fork 14
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
[Unitary-Hack][Sub-Braket] Doc string in submission/braket.py #981
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #981 +/- ##
==========================================
+ Coverage 89.90% 89.91% +0.01%
==========================================
Files 110 110
Lines 8132 8132
==========================================
+ Hits 7311 7312 +1
+ Misses 821 820 -1 ☔ View full report in Codecov by Sentry. |
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.
Small note about IR
, also please remove the indents per my other comments on your PRs.
Hi @weinbe58 , @Roger-luo agreed here in #970 (comment) thats its okay to ident the args if looks good in locally rendered documentation. I have attached the locally rendered doc as the PDF file in PR Description.. Thats why I indented the args here and in the other PRs. Lets close on this conversation in my other PR, about whether to indent the args or not. Locally, I have seen no-effect to sometimes bad rendering. |
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.
overall looks OK but missing some context about execution, see my comment #980 about the wording the doc strings.
Fixes #957.
Locally rendered doc:
sub_braket.pdf