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

[Unitary-Hack][Sub-quera] Doc string for submission/quera.py #980

Closed

Conversation

Manvi-Agrawal
Copy link
Contributor

@Manvi-Agrawal Manvi-Agrawal commented Jun 1, 2024

Fixes #957

Locally rendered doc:
sub_quera.pdf

@Manvi-Agrawal Manvi-Agrawal changed the title [Uh] Doc for sub-quera [Unitary-Hack][Sub-quera] Doc string for submission/quera.py Jun 1, 2024
Copy link
Member

@weinbe58 weinbe58 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove indents when arguments/attributes have to go across multipe lines.

@Manvi-Agrawal
Copy link
Contributor Author

Manvi-Agrawal commented Jun 5, 2024

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.

src/bloqade/submission/quera.py Outdated Show resolved Hide resolved
Co-authored-by: Phillip Weinberg <weinbe58@gmail.com>
Copy link

codecov bot commented Jun 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.91%. Comparing base (777ef19) to head (e8b6a28).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #980      +/-   ##
==========================================
+ 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.
📢 Have feedback on the report? Share it here.

@weinbe58 weinbe58 closed this Aug 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

improve docstrings
3 participants