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-ir-task_result] Doc strings in submission/ir/task_result.py #979

Conversation

Manvi-Agrawal
Copy link
Contributor

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

Fixes #957

Rendered documentation

bloqade-sub-ir-task-result.pdf

@Manvi-Agrawal Manvi-Agrawal changed the title [Unitary-Hack] [Unitary-Hack][Submission-ir-task_result] Doc strings in submission/ir/task_result.py Jun 1, 2024
@Manvi-Agrawal Manvi-Agrawal changed the title [Unitary-Hack][Submission-ir-task_result] Doc strings in submission/ir/task_result.py [Unitary-Hack][Sub-ir-task_result] Doc strings in submission/ir/task_result.py Jun 1, 2024
@Manvi-Agrawal
Copy link
Contributor Author

@Roger-luo , I have checked that this PR follows the discussion and feedback in #970. Could you please take a look?

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.

These look good but you need to remove the indentation for multiline doc strings. I know it looks bad but it will look bad when rendering the documentation online.

src/bloqade/submission/ir/task_results.py Show resolved Hide resolved
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 (0692d05) to head (171080c).
Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #979      +/-   ##
==========================================
+ 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
2 participants